v24 Active and Available Inventory REST API

Version: v24



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.

Schemes: https

Summary

  1. Tag: CloudInfrastructure
  2. Tag: ExternalSystem
  3. Tag: Business
  4. Tag: ServiceDesignAndCreation
  5. Tag: Network
  6. Tag: Common
  7. Paths
  8. Schema definitions

Tag: CloudInfrastructure

OperationDescription
GET /cloud-infrastructure/cloud-regions

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

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

create or update an existing cloud-region
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}

update an existing cloud-region
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}

delete an existing cloud-region
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/activities

returns activities
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/activities/activity/{activity-id}

returns activity
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/activities/activity/{activity-id}

create or update an existing activity
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/activities/activity/{activity-id}

update an existing activity
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/activities/activity/{activity-id}

delete an existing activity
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/activities/activity/{activity-id}/activity-states

returns activity-states
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

returns activity-state
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

create or update an existing activity-state
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

update an existing activity-state
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

delete an existing activity-state
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}/relationship-list/relationship

delete an existing relationship
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/activities/activity/{activity-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/activities/activity/{activity-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones

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

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

create or update an existing availability-zone
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}

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

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

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches

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

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

create or update an existing dvs-switch
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}

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

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

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list

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

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

create or update an existing esr-system-info
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

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

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

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors

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

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

create or update an existing flavor
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}

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

delete an existing flavor
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities

returns hpa-capabilities
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

returns hpa-capability
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

create or update an existing hpa-capability
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

update an existing hpa-capability
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

delete an existing hpa-capability
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}

returns hpa-feature-attributes
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}

create or update an existing hpa-feature-attributes
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}

update an existing hpa-feature-attributes
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}

delete an existing hpa-feature-attributes
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}/relationship-list/relationship

delete an existing relationship
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship

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

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments

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

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

create or update an existing group-assignment
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

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

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

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/host-aggregates

returns host-aggregates
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/host-aggregates/host-aggregate/{host-aggregate-id}

returns host-aggregate
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/host-aggregates/host-aggregate/{host-aggregate-id}

create or update an existing host-aggregate
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/host-aggregates/host-aggregate/{host-aggregate-id}

update an existing host-aggregate
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/host-aggregates/host-aggregate/{host-aggregate-id}

delete an existing host-aggregate
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/host-aggregates/host-aggregate/{host-aggregate-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/host-aggregates/host-aggregate/{host-aggregate-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities

returns hpa-capabilities
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

returns hpa-capability
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

create or update an existing hpa-capability
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

update an existing hpa-capability
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

delete an existing hpa-capability
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}

returns hpa-feature-attributes
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}

create or update an existing hpa-feature-attributes
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}

update an existing hpa-feature-attributes
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}

delete an existing hpa-feature-attributes
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}/relationship-list/relationship

delete an existing relationship
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images

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

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

create or update an existing image
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}

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

delete an existing image
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata

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

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

create or update an existing metadatum
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}

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

delete an existing metadatum
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks

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

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

create or update an existing oam-network
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}

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

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

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship

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

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots

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

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

create or update an existing snapshot
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}

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

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

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants

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

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

create or update an existing tenant
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}

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

delete an existing tenant
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/k8s-resources

returns k8s-resources
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/k8s-resources/k8s-resource/{id}

returns k8s-resource
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/k8s-resources/k8s-resource/{id}

create or update an existing k8s-resource
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/k8s-resources/k8s-resource/{id}

update an existing k8s-resource
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/k8s-resources/k8s-resource/{id}

delete an existing k8s-resource
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/k8s-resources/k8s-resource/{id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/k8s-resources/k8s-resource/{id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/nos-servers

returns nos-servers
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/nos-servers/nos-server/{nos-server-id}

returns nos-server
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/nos-servers/nos-server/{nos-server-id}

create or update an existing nos-server
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/nos-servers/nos-server/{nos-server-id}

update an existing nos-server
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/nos-servers/nos-server/{nos-server-id}

delete an existing nos-server
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/nos-servers/nos-server/{nos-server-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/nos-servers/nos-server/{nos-server-id}/relationship-list/relationship

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

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers

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

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

create or update an existing vserver
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}

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

delete an existing vserver
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces

returns l-interfaces
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}

returns l-interface
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}

create or update an existing l-interface
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}

update an existing l-interface
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}

delete an existing l-interface
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables

returns lcmp-unreachables
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

returns lcmp-unreachable
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

create or update an existing lcmp-unreachable
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

update an existing lcmp-unreachable
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

delete an existing lcmp-unreachable
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

delete an existing relationship
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs

returns sriov-vfs
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

returns sriov-vf
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

create or update an existing sriov-vf
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

update an existing sriov-vf
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

delete an existing sriov-vf
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists

returns temporary-parameter-lists
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

returns temporary-parameter-list
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

create or update an existing temporary-parameter-list
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

update an existing temporary-parameter-list
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

delete an existing temporary-parameter-list
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans

returns vlans
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

returns vlan
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

update an existing vlan
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

delete an existing vlan
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

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

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes

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

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

create or update an existing volume
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

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

delete an existing volume
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/validation-audits

returns validation-audits
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/validation-audits/validation-audit/{validation-id}

returns validation-audit
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/validation-audits/validation-audit/{validation-id}

create or update an existing validation-audit
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/validation-audits/validation-audit/{validation-id}

update an existing validation-audit
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/validation-audits/validation-audit/{validation-id}

delete an existing validation-audit
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/validation-audits/validation-audit/{validation-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/validation-audits/validation-audit/{validation-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}

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

create or update an existing vip-ipv4-address-list
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}

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

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

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}

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

create or update an existing vip-ipv6-address-list
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}

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

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

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vlan-ranges

returns vlan-ranges
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vlan-ranges/vlan-range/{vlan-range-id}

returns vlan-range
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vlan-ranges/vlan-range/{vlan-range-id}

create or update an existing vlan-range
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vlan-ranges/vlan-range/{vlan-range-id}

update an existing vlan-range
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vlan-ranges/vlan-range/{vlan-range-id}

delete an existing vlan-range
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vlan-ranges/vlan-range/{vlan-range-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vlan-ranges/vlan-range/{vlan-range-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vlan-ranges/vlan-range/{vlan-range-id}/vlan-tags

returns vlan-tags
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vlan-ranges/vlan-range/{vlan-range-id}/vlan-tags/vlan-tag/{vlan-tag-id}

returns vlan-tag
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vlan-ranges/vlan-range/{vlan-range-id}/vlan-tags/vlan-tag/{vlan-tag-id}

create or update an existing vlan-tag
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vlan-ranges/vlan-range/{vlan-range-id}/vlan-tags/vlan-tag/{vlan-tag-id}

update an existing vlan-tag
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vlan-ranges/vlan-range/{vlan-range-id}/vlan-tags/vlan-tag/{vlan-tag-id}

delete an existing vlan-tag
PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vlan-ranges/vlan-range/{vlan-range-id}/vlan-tags/vlan-tag/{vlan-tag-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vlan-ranges/vlan-range/{vlan-range-id}/vlan-tags/vlan-tag/{vlan-tag-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups

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

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

create or update an existing volume-group
PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

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

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

see node definition for valid relationships
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/complexes

returns complexes
GET /cloud-infrastructure/complexes/complex/{physical-location-id}

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

create or update an existing complex
PATCH /cloud-infrastructure/complexes/complex/{physical-location-id}

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

delete an existing complex
GET /cloud-infrastructure/complexes/complex/{physical-location-id}/cables

returns cables
GET /cloud-infrastructure/complexes/complex/{physical-location-id}/cables/cable/{cable-name}

returns cable
PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/cables/cable/{cable-name}

create or update an existing cable
PATCH /cloud-infrastructure/complexes/complex/{physical-location-id}/cables/cable/{cable-name}

update an existing cable
DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/cables/cable/{cable-name}

delete an existing cable
PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/cables/cable/{cable-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/cables/cable/{cable-name}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools

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

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

create or update an existing ctag-pool
PATCH /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}

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

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

see node definition for valid relationships
DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/complexes/complex/{physical-location-id}/racks

returns racks
GET /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}

returns rack
PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}

create or update an existing rack
PATCH /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}

update an existing rack
DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}

delete an existing rack
GET /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}/pdus

returns pdus
GET /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}/pdus/pdu/{pdu-name}

returns pdu
PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}/pdus/pdu/{pdu-name}

create or update an existing pdu
PATCH /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}/pdus/pdu/{pdu-name}

update an existing pdu
DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}/pdus/pdu/{pdu-name}

delete an existing pdu
PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}/pdus/pdu/{pdu-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}/pdus/pdu/{pdu-name}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}/rack-units

returns rack-units
GET /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}/rack-units/rack-unit/{rack-unit-name}

returns rack-unit
PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}/rack-units/rack-unit/{rack-unit-name}

create or update an existing rack-unit
PATCH /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}/rack-units/rack-unit/{rack-unit-name}

update an existing rack-unit
DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}/rack-units/rack-unit/{rack-unit-name}

delete an existing rack-unit
PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}/rack-units/rack-unit/{rack-unit-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}/rack-units/rack-unit/{rack-unit-name}/relationship-list/relationship

delete an existing relationship
PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}/relationship-list/relationship

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

see node definition for valid relationships
DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/endpoints

returns endpoints
GET /cloud-infrastructure/endpoints/endpoint/{endpoint-id}

returns endpoint
PUT /cloud-infrastructure/endpoints/endpoint/{endpoint-id}

create or update an existing endpoint
PATCH /cloud-infrastructure/endpoints/endpoint/{endpoint-id}

update an existing endpoint
DELETE /cloud-infrastructure/endpoints/endpoint/{endpoint-id}

delete an existing endpoint
GET /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/ip-address-list/{ip-address}

returns ip-address-list
PUT /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/ip-address-list/{ip-address}

create or update an existing ip-address-list
PATCH /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/ip-address-list/{ip-address}

update an existing ip-address-list
DELETE /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/ip-address-list/{ip-address}

delete an existing ip-address-list
PUT /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/ip-address-list/{ip-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/ip-address-list/{ip-address}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/port-list/{port}

returns port-list
PUT /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/port-list/{port}

create or update an existing port-list
PATCH /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/port-list/{port}

update an existing port-list
DELETE /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/port-list/{port}

delete an existing port-list
PUT /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/port-list/{port}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/port-list/{port}/relationship-list/relationship

delete an existing relationship
PUT /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/selector-list/{selector}

returns selector-list
PUT /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/selector-list/{selector}

create or update an existing selector-list
PATCH /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/selector-list/{selector}

update an existing selector-list
DELETE /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/selector-list/{selector}

delete an existing selector-list
PUT /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/selector-list/{selector}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/selector-list/{selector}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/geo-regions

returns geo-regions
GET /cloud-infrastructure/geo-regions/geo-region/{geo-region-id}

returns geo-region
PUT /cloud-infrastructure/geo-regions/geo-region/{geo-region-id}

create or update an existing geo-region
PATCH /cloud-infrastructure/geo-regions/geo-region/{geo-region-id}

update an existing geo-region
DELETE /cloud-infrastructure/geo-regions/geo-region/{geo-region-id}

delete an existing geo-region
PUT /cloud-infrastructure/geo-regions/geo-region/{geo-region-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/geo-regions/geo-region/{geo-region-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/network-profiles

returns network-profiles
GET /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

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

create or update an existing network-profile
PATCH /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

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

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

see node definition for valid relationships
DELETE /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/network-technologies

returns network-technologies
GET /cloud-infrastructure/network-technologies/network-technology/{network-technology-id}

returns network-technology
PUT /cloud-infrastructure/network-technologies/network-technology/{network-technology-id}

create or update an existing network-technology
PATCH /cloud-infrastructure/network-technologies/network-technology/{network-technology-id}

update an existing network-technology
DELETE /cloud-infrastructure/network-technologies/network-technology/{network-technology-id}

delete an existing network-technology
PUT /cloud-infrastructure/network-technologies/network-technology/{network-technology-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/network-technologies/network-technology/{network-technology-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/operational-environments

returns operational-environments
GET /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}

returns operational-environment
PUT /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}

create or update an existing operational-environment
PATCH /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}

update an existing operational-environment
DELETE /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}

delete an existing operational-environment
PUT /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers

returns pservers
GET /cloud-infrastructure/pservers/pserver/{hostname}

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

create or update an existing pserver
PATCH /cloud-infrastructure/pservers/pserver/{hostname}

update an existing pserver
DELETE /cloud-infrastructure/pservers/pserver/{hostname}

delete an existing pserver
GET /cloud-infrastructure/pservers/pserver/{hostname}/activities

returns activities
GET /cloud-infrastructure/pservers/pserver/{hostname}/activities/activity/{activity-id}

returns activity
PUT /cloud-infrastructure/pservers/pserver/{hostname}/activities/activity/{activity-id}

create or update an existing activity
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/activities/activity/{activity-id}

update an existing activity
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/activities/activity/{activity-id}

delete an existing activity
GET /cloud-infrastructure/pservers/pserver/{hostname}/activities/activity/{activity-id}/activity-states

returns activity-states
GET /cloud-infrastructure/pservers/pserver/{hostname}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

returns activity-state
PUT /cloud-infrastructure/pservers/pserver/{hostname}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

create or update an existing activity-state
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

update an existing activity-state
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

delete an existing activity-state
PUT /cloud-infrastructure/pservers/pserver/{hostname}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}/relationship-list/relationship

delete an existing relationship
PUT /cloud-infrastructure/pservers/pserver/{hostname}/activities/activity/{activity-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/activities/activity/{activity-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers/pserver/{hostname}/hpa-capacity/{hpa-capacity-key}

returns hpa-capacity
PUT /cloud-infrastructure/pservers/pserver/{hostname}/hpa-capacity/{hpa-capacity-key}

create or update an existing hpa-capacity
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/hpa-capacity/{hpa-capacity-key}

update an existing hpa-capacity
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/hpa-capacity/{hpa-capacity-key}

delete an existing hpa-capacity
PUT /cloud-infrastructure/pservers/pserver/{hostname}/hpa-capacity/{hpa-capacity-key}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/hpa-capacity/{hpa-capacity-key}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces

returns l-interfaces
GET /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}

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

create or update an existing l-interface
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}

update an existing l-interface
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}

delete an existing l-interface
GET /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables

returns lcmp-unreachables
GET /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

returns lcmp-unreachable
PUT /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

create or update an existing lcmp-unreachable
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

update an existing lcmp-unreachable
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

delete an existing lcmp-unreachable
PUT /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

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

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/sriov-vfs

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

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

create or update an existing sriov-vf
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

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

delete an existing sriov-vf
PUT /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists

returns temporary-parameter-lists
GET /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

returns temporary-parameter-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

create or update an existing temporary-parameter-list
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

update an existing temporary-parameter-list
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

delete an existing temporary-parameter-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/vlans

returns vlans
GET /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

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

create or update an existing vlan
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

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

delete an existing vlan
GET /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship
PUT /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces

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

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

create or update an existing lag-interface
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

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

delete an existing lag-interface
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options

returns aggregated-ether-options
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}

returns aggregated-ether-option
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}

create or update an existing aggregated-ether-option
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}

update an existing aggregated-ether-option
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}

delete an existing aggregated-ether-option
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps

returns lacps
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}

returns lacp
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}

create or update an existing lacp
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}

update an existing lacp
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}

delete an existing lacp
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}/relationship-list/relationship

delete an existing relationship
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/esis

returns esis
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}

returns esi
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}

create or update an existing esi
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}

update an existing esi
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}

delete an existing esi
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

returns l-interfaces
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

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

create or update an existing l-interface
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

update an existing l-interface
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

delete an existing l-interface
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables

returns lcmp-unreachables
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

returns lcmp-unreachable
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

create or update an existing lcmp-unreachable
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

update an existing lcmp-unreachable
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

delete an existing lcmp-unreachable
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

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

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs

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

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

create or update an existing sriov-vf
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}

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

delete an existing sriov-vf
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists

returns temporary-parameter-lists
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

returns temporary-parameter-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

create or update an existing temporary-parameter-list
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

update an existing temporary-parameter-list
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

delete an existing temporary-parameter-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans

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

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

create or update an existing vlan
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

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

delete an existing vlan
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

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

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists

returns temporary-parameter-lists
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

returns temporary-parameter-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

create or update an existing temporary-parameter-list
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

update an existing temporary-parameter-list
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

delete an existing temporary-parameter-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces

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

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

create or update an existing p-interface
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

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

delete an existing p-interface
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/activities

returns activities
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}

returns activity
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}

create or update an existing activity
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}

update an existing activity
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}

delete an existing activity
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states

returns activity-states
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

returns activity-state
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

create or update an existing activity-state
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

update an existing activity-state
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

delete an existing activity-state
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}/relationship-list/relationship

delete an existing relationship
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes

returns bandwidth-attributes
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}

returns bandwidth-attribute
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}

create or update an existing bandwidth-attribute
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}

update an existing bandwidth-attribute
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}

delete an existing bandwidth-attribute
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map

returns available-bandwidth-map
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}

returns available-bandwidth
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}

create or update an existing available-bandwidth
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}

update an existing available-bandwidth
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}

delete an existing available-bandwidth
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}/relationship-list/relationship

delete an existing relationship
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/gig-ether-options

returns gig-ether-options
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}

returns gig-ether-option
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}

create or update an existing gig-ether-option
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}

update an existing gig-ether-option
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}

delete an existing gig-ether-option
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/hold-timers

returns hold-timers
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/hold-timers/hold-timer/{hold-timer-id}

returns hold-timer
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/hold-timers/hold-timer/{hold-timer-id}

create or update an existing hold-timer
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/hold-timers/hold-timer/{hold-timer-id}

update an existing hold-timer
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/hold-timers/hold-timer/{hold-timer-id}

delete an existing hold-timer
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/hold-timers/hold-timer/{hold-timer-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/hold-timers/hold-timer/{hold-timer-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces

returns l-interfaces
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

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

create or update an existing l-interface
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

update an existing l-interface
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

delete an existing l-interface
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables

returns lcmp-unreachables
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

returns lcmp-unreachable
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

create or update an existing lcmp-unreachable
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

update an existing lcmp-unreachable
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

delete an existing lcmp-unreachable
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

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

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs

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

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

create or update an existing sriov-vf
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}

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

delete an existing sriov-vf
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists

returns temporary-parameter-lists
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

returns temporary-parameter-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

create or update an existing temporary-parameter-list
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

update an existing temporary-parameter-list
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

delete an existing temporary-parameter-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans

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

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

create or update an existing vlan
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

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

delete an existing vlan
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

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

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs

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

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

create or update an existing sriov-pf
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

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

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

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists

returns temporary-parameter-lists
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

returns temporary-parameter-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

create or update an existing temporary-parameter-list
PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

update an existing temporary-parameter-list
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

delete an existing temporary-parameter-list
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

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

see node definition for valid relationships
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship

delete an existing relationship
GET /cloud-infrastructure/virtual-data-centers

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

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

create or update an existing virtual-data-center
PATCH /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

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

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

see node definition for valid relationships
DELETE /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship

delete an existing relationship

Tag: ExternalSystem

OperationDescription
GET /external-system/esr-ems-list

returns esr-ems-list
GET /external-system/esr-ems-list/esr-ems/{ems-id}

returns esr-ems
PUT /external-system/esr-ems-list/esr-ems/{ems-id}

create or update an existing esr-ems
PATCH /external-system/esr-ems-list/esr-ems/{ems-id}

update an existing esr-ems
DELETE /external-system/esr-ems-list/esr-ems/{ems-id}

delete an existing esr-ems
GET /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list

returns esr-system-info-list
GET /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

returns esr-system-info
PUT /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

create or update an existing esr-system-info
PATCH /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

update an existing esr-system-info
DELETE /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

delete an existing esr-system-info
PUT /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

delete an existing relationship
PUT /external-system/esr-ems-list/esr-ems/{ems-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /external-system/esr-ems-list/esr-ems/{ems-id}/relationship-list/relationship

delete an existing relationship
GET /external-system/esr-nfvo-list

returns esr-nfvo-list
GET /external-system/esr-nfvo-list/esr-nfvo/{nfvo-id}

returns esr-nfvo
PUT /external-system/esr-nfvo-list/esr-nfvo/{nfvo-id}

create or update an existing esr-nfvo
PATCH /external-system/esr-nfvo-list/esr-nfvo/{nfvo-id}

update an existing esr-nfvo
DELETE /external-system/esr-nfvo-list/esr-nfvo/{nfvo-id}

delete an existing esr-nfvo
GET /external-system/esr-nfvo-list/esr-nfvo/{nfvo-id}/esr-system-info-list

returns esr-system-info-list
GET /external-system/esr-nfvo-list/esr-nfvo/{nfvo-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

returns esr-system-info
PUT /external-system/esr-nfvo-list/esr-nfvo/{nfvo-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

create or update an existing esr-system-info
PATCH /external-system/esr-nfvo-list/esr-nfvo/{nfvo-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

update an existing esr-system-info
DELETE /external-system/esr-nfvo-list/esr-nfvo/{nfvo-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

delete an existing esr-system-info
PUT /external-system/esr-nfvo-list/esr-nfvo/{nfvo-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /external-system/esr-nfvo-list/esr-nfvo/{nfvo-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

delete an existing relationship
PUT /external-system/esr-nfvo-list/esr-nfvo/{nfvo-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /external-system/esr-nfvo-list/esr-nfvo/{nfvo-id}/relationship-list/relationship

delete an existing relationship
GET /external-system/esr-thirdparty-sdnc-list

returns esr-thirdparty-sdnc-list
GET /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}

returns esr-thirdparty-sdnc
PUT /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}

create or update an existing esr-thirdparty-sdnc
PATCH /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}

update an existing esr-thirdparty-sdnc
DELETE /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}

delete an existing esr-thirdparty-sdnc
GET /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list

returns esr-system-info-list
GET /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

returns esr-system-info
PUT /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

create or update an existing esr-system-info
PATCH /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

update an existing esr-system-info
DELETE /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

delete an existing esr-system-info
PUT /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

delete an existing relationship
PUT /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/relationship-list/relationship

delete an existing relationship
GET /external-system/esr-vnfm-list

returns esr-vnfm-list
GET /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}

returns esr-vnfm
PUT /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}

create or update an existing esr-vnfm
PATCH /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}

update an existing esr-vnfm
DELETE /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}

delete an existing esr-vnfm
GET /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list

returns esr-system-info-list
GET /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

returns esr-system-info
PUT /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

create or update an existing esr-system-info
PATCH /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

update an existing esr-system-info
DELETE /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

delete an existing esr-system-info
PUT /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

delete an existing relationship
PUT /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/relationship-list/relationship

delete an existing relationship

Tag: Business

OperationDescription
GET /business/connectors

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

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

create or update an existing connector
PATCH /business/connectors/connector/{resource-instance-id}

update an existing connector
DELETE /business/connectors/connector/{resource-instance-id}

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

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

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

create or update an existing metadatum
PATCH /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}

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

delete an existing metadatum
PUT /business/connectors/connector/{resource-instance-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /business/connectors/connector/{resource-instance-id}/relationship-list/relationship

delete an existing relationship
GET /business/customers

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

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

create or update an existing customer
PATCH /business/customers/customer/{global-customer-id}

update an existing customer
DELETE /business/customers/customer/{global-customer-id}

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

see node definition for valid relationships
DELETE /business/customers/customer/{global-customer-id}/relationship-list/relationship

delete an existing relationship
GET /business/customers/customer/{global-customer-id}/service-subscriptions

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

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

create or update an existing service-subscription
PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}

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

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

see node definition for valid relationships
DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship

delete an existing relationship
GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances

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

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

create or update an existing service-instance
PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}

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

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

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

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

create or update an existing allotted-resource
PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}

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

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

see node definition for valid relationships
DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/relationship-list/relationship

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

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

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

create or update an existing tunnel-xconnect
PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{tunnel-xconnect.id}

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

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

see node definition for valid relationships
DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{tunnel-xconnect.id}/relationship-list/relationship

delete an existing relationship
GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/communication-service-profiles

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

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

create or update an existing communication-service-profile
PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/communication-service-profiles/communication-service-profile/{profile-id}

update an existing communication-service-profile
DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/communication-service-profiles/communication-service-profile/{profile-id}

delete an existing communication-service-profile
PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/communication-service-profiles/communication-service-profile/{profile-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/communication-service-profiles/communication-service-profile/{profile-id}/relationship-list/relationship

delete an existing relationship
GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/composed-resources

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

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

create or update an existing composed-resource
PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/composed-resources/composed-resource/{id}

update an existing composed-resource
DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/composed-resources/composed-resource/{id}

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

see node definition for valid relationships
DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/composed-resources/composed-resource/{id}/relationship-list/relationship

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

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

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

create or update an existing metadatum
PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}

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

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

see node definition for valid relationships
DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship

delete an existing relationship
GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/service-profiles

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

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

create or update an existing service-profile
PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/service-profiles/service-profile/{profile-id}

update an existing service-profile
DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/service-profiles/service-profile/{profile-id}

delete an existing service-profile
PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/service-profiles/service-profile/{profile-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/service-profiles/service-profile/{profile-id}/relationship-list/relationship

delete an existing relationship
GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/slice-profiles

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

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

create or update an existing slice-profile
PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/slice-profiles/slice-profile/{profile-id}

update an existing slice-profile
DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/slice-profiles/slice-profile/{profile-id}

delete an existing slice-profile
PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/slice-profiles/slice-profile/{profile-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/slice-profiles/slice-profile/{profile-id}/relationship-list/relationship

delete an existing relationship
GET /business/lines-of-business

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

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

create or update an existing line-of-business
PATCH /business/lines-of-business/line-of-business/{line-of-business-name}

update an existing line-of-business
DELETE /business/lines-of-business/line-of-business/{line-of-business-name}

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

see node definition for valid relationships
DELETE /business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship

delete an existing relationship
GET /business/owning-entities

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

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

create or update an existing owning-entity
PATCH /business/owning-entities/owning-entity/{owning-entity-id}

update an existing owning-entity
DELETE /business/owning-entities/owning-entity/{owning-entity-id}

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

see node definition for valid relationships
DELETE /business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship

delete an existing relationship
GET /business/platforms

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

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

create or update an existing platform
PATCH /business/platforms/platform/{platform-name}

update an existing platform
DELETE /business/platforms/platform/{platform-name}

delete an existing platform
PUT /business/platforms/platform/{platform-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /business/platforms/platform/{platform-name}/relationship-list/relationship

delete an existing relationship
GET /business/projects

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

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

create or update an existing project
PATCH /business/projects/project/{project-name}

update an existing project
DELETE /business/projects/project/{project-name}

delete an existing project
PUT /business/projects/project/{project-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /business/projects/project/{project-name}/relationship-list/relationship

delete an existing relationship
GET /business/sp-partners

returns sp-partners
GET /business/sp-partners/sp-partner/{sp-partner-id}

returns sp-partner
PUT /business/sp-partners/sp-partner/{sp-partner-id}

create or update an existing sp-partner
PATCH /business/sp-partners/sp-partner/{sp-partner-id}

update an existing sp-partner
DELETE /business/sp-partners/sp-partner/{sp-partner-id}

delete an existing sp-partner
PUT /business/sp-partners/sp-partner/{sp-partner-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /business/sp-partners/sp-partner/{sp-partner-id}/relationship-list/relationship

delete an existing relationship

Tag: ServiceDesignAndCreation

OperationDescription
GET /service-design-and-creation/models

returns models
GET /service-design-and-creation/models/model/{model-invariant-id}

returns model
PUT /service-design-and-creation/models/model/{model-invariant-id}

create or update an existing model
PATCH /service-design-and-creation/models/model/{model-invariant-id}

update an existing model
DELETE /service-design-and-creation/models/model/{model-invariant-id}

delete an existing model
GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers

returns model-vers
GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

returns model-ver
PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

create or update an existing model-ver
PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

update an existing model-ver
DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

delete an existing model-ver
GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata

returns metadata
GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

returns metadatum
PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

create or update an existing metadatum
PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

update an existing metadatum
DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

delete an existing metadatum
GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements

returns model-elements
GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}

returns model-element
PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}

create or update an existing model-element
PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}

update an existing model-element
DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}

delete an existing model-element
GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints

returns model-constraints
GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

returns model-constraint
PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

create or update an existing model-constraint
PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

update an existing model-constraint
DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

delete an existing model-constraint
GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets

returns constrained-element-sets
GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

returns constrained-element-set
PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

create or update an existing constrained-element-set
PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

update an existing constrained-element-set
DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

delete an existing constrained-element-set
GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets

returns element-choice-sets
GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

returns element-choice-set
PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

create or update an existing element-choice-set
PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

update an existing element-choice-set
DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

delete an existing element-choice-set
PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship

see node definition for valid relationships
DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship

delete an existing relationship
PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/relationship-list/relationship

see node definition for valid relationships
DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/relationship-list/relationship

delete an existing relationship
PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship

see node definition for valid relationships
DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship

delete an existing relationship
PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship

delete an existing relationship
PUT /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship

delete an existing relationship
GET /service-design-and-creation/named-queries

returns named-queries
GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}

returns named-query
PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}

create or update an existing named-query
PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}

update an existing named-query
DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}

delete an existing named-query
GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements

returns named-query-elements
GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}

returns named-query-element
PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}

create or update an existing named-query-element
PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}

update an existing named-query-element
DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}

delete an existing named-query-element
GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints

returns property-constraints
GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}

returns property-constraint
PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}

create or update an existing property-constraint
PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}

update an existing property-constraint
DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}

delete an existing property-constraint
GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups

returns related-lookups
GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}

returns related-lookup
PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}

create or update an existing related-lookup
PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}

update an existing related-lookup
DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}

delete an existing related-lookup
PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}/relationship-list/relationship

see node definition for valid relationships
DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}/relationship-list/relationship

delete an existing relationship
PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship

see node definition for valid relationships
DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship

delete an existing relationship
PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship

see node definition for valid relationships
DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship

delete an existing relationship
GET /service-design-and-creation/service-capabilities

returns service-capabilities
GET /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

returns service-capability
PUT /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

create or update an existing service-capability
PATCH /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

update an existing service-capability
DELETE /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

delete an existing service-capability
PUT /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship

see node definition for valid relationships
DELETE /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship

delete an existing relationship
GET /service-design-and-creation/services

returns services
GET /service-design-and-creation/services/service/{service-id}

returns service
PUT /service-design-and-creation/services/service/{service-id}

create or update an existing service
PATCH /service-design-and-creation/services/service/{service-id}

update an existing service
DELETE /service-design-and-creation/services/service/{service-id}

delete an existing service
PUT /service-design-and-creation/services/service/{service-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /service-design-and-creation/services/service/{service-id}/relationship-list/relationship

delete an existing relationship
GET /service-design-and-creation/vnf-images

returns vnf-images
GET /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

returns vnf-image
PUT /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

create or update an existing vnf-image
PATCH /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

update an existing vnf-image
DELETE /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

delete an existing vnf-image
PUT /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship

see node definition for valid relationships
DELETE /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship

delete an existing relationship

Tag: Network

OperationDescription
GET /network/autonomous-systems

returns autonomous-systems
GET /network/autonomous-systems/autonomous-system/{autonomous-system-id}

returns autonomous-system
PUT /network/autonomous-systems/autonomous-system/{autonomous-system-id}

create or update an existing autonomous-system
PATCH /network/autonomous-systems/autonomous-system/{autonomous-system-id}

update an existing autonomous-system
DELETE /network/autonomous-systems/autonomous-system/{autonomous-system-id}

delete an existing autonomous-system
PUT /network/autonomous-systems/autonomous-system/{autonomous-system-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/autonomous-systems/autonomous-system/{autonomous-system-id}/relationship-list/relationship

delete an existing relationship
GET /network/bfds

returns bfds
GET /network/bfds/bfd/{bfd-id}

returns bfd
PUT /network/bfds/bfd/{bfd-id}

create or update an existing bfd
PATCH /network/bfds/bfd/{bfd-id}

update an existing bfd
DELETE /network/bfds/bfd/{bfd-id}

delete an existing bfd
PUT /network/bfds/bfd/{bfd-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/bfds/bfd/{bfd-id}/relationship-list/relationship

delete an existing relationship
GET /network/chassies

returns chassies
GET /network/chassies/chassis/{chassis-name}

returns chassis
PUT /network/chassies/chassis/{chassis-name}

create or update an existing chassis
PATCH /network/chassies/chassis/{chassis-name}

update an existing chassis
DELETE /network/chassies/chassis/{chassis-name}

delete an existing chassis
GET /network/chassies/chassis/{chassis-name}/card-slots

returns card-slots
GET /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}

returns card-slot
PUT /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}

create or update an existing card-slot
PATCH /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}

update an existing card-slot
DELETE /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}

delete an existing card-slot
GET /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards

returns cards
GET /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}

returns card
PUT /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}

create or update an existing card
PATCH /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}

update an existing card
DELETE /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}

delete an existing card
GET /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots

returns pluggable-slots
GET /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}

returns pluggable-slot
PUT /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}

create or update an existing pluggable-slot
PATCH /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}

update an existing pluggable-slot
DELETE /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}

delete an existing pluggable-slot
GET /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}/pluggables

returns pluggables
GET /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}/pluggables/pluggable/{pluggable-type}

returns pluggable
PUT /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}/pluggables/pluggable/{pluggable-type}

create or update an existing pluggable
PATCH /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}/pluggables/pluggable/{pluggable-type}

update an existing pluggable
DELETE /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}/pluggables/pluggable/{pluggable-type}

delete an existing pluggable
GET /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}/pluggables/pluggable/{pluggable-type}/ports

returns ports
GET /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}/pluggables/pluggable/{pluggable-type}/ports/port/{port-name}

returns port
PUT /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}/pluggables/pluggable/{pluggable-type}/ports/port/{port-name}

create or update an existing port
PATCH /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}/pluggables/pluggable/{pluggable-type}/ports/port/{port-name}

update an existing port
DELETE /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}/pluggables/pluggable/{pluggable-type}/ports/port/{port-name}

delete an existing port
PUT /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}/pluggables/pluggable/{pluggable-type}/ports/port/{port-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}/pluggables/pluggable/{pluggable-type}/ports/port/{port-name}/relationship-list/relationship

delete an existing relationship
PUT /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}/pluggables/pluggable/{pluggable-type}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}/pluggables/pluggable/{pluggable-type}/relationship-list/relationship

delete an existing relationship
PUT /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}/relationship-list/relationship

delete an existing relationship
GET /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/ports

returns ports
GET /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/ports/port/{port-name}

returns port
PUT /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/ports/port/{port-name}

create or update an existing port
PATCH /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/ports/port/{port-name}

update an existing port
DELETE /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/ports/port/{port-name}

delete an existing port
PUT /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/ports/port/{port-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/ports/port/{port-name}/relationship-list/relationship

delete an existing relationship
PUT /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/relationship-list/relationship

delete an existing relationship
PUT /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/relationship-list/relationship

delete an existing relationship
GET /network/chassies/chassis/{chassis-name}/licenses

returns licenses
GET /network/chassies/chassis/{chassis-name}/licenses/license/{group-uuid}/{resource-uuid}

returns license
PUT /network/chassies/chassis/{chassis-name}/licenses/license/{group-uuid}/{resource-uuid}

create or update an existing license
PATCH /network/chassies/chassis/{chassis-name}/licenses/license/{group-uuid}/{resource-uuid}

update an existing license
DELETE /network/chassies/chassis/{chassis-name}/licenses/license/{group-uuid}/{resource-uuid}

delete an existing license
PUT /network/chassies/chassis/{chassis-name}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/chassies/chassis/{chassis-name}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

delete an existing relationship
GET /network/chassies/chassis/{chassis-name}/pluggable-slots

returns pluggable-slots
GET /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}

returns pluggable-slot
PUT /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}

create or update an existing pluggable-slot
PATCH /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}

update an existing pluggable-slot
DELETE /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}

delete an existing pluggable-slot
GET /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}/pluggables

returns pluggables
GET /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}/pluggables/pluggable/{pluggable-type}

returns pluggable
PUT /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}/pluggables/pluggable/{pluggable-type}

create or update an existing pluggable
PATCH /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}/pluggables/pluggable/{pluggable-type}

update an existing pluggable
DELETE /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}/pluggables/pluggable/{pluggable-type}

delete an existing pluggable
GET /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}/pluggables/pluggable/{pluggable-type}/ports

returns ports
GET /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}/pluggables/pluggable/{pluggable-type}/ports/port/{port-name}

returns port
PUT /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}/pluggables/pluggable/{pluggable-type}/ports/port/{port-name}

create or update an existing port
PATCH /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}/pluggables/pluggable/{pluggable-type}/ports/port/{port-name}

update an existing port
DELETE /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}/pluggables/pluggable/{pluggable-type}/ports/port/{port-name}

delete an existing port
PUT /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}/pluggables/pluggable/{pluggable-type}/ports/port/{port-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}/pluggables/pluggable/{pluggable-type}/ports/port/{port-name}/relationship-list/relationship

delete an existing relationship
PUT /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}/pluggables/pluggable/{pluggable-type}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}/pluggables/pluggable/{pluggable-type}/relationship-list/relationship

delete an existing relationship
PUT /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}/relationship-list/relationship

delete an existing relationship
GET /network/chassies/chassis/{chassis-name}/ports

returns ports
GET /network/chassies/chassis/{chassis-name}/ports/port/{port-name}

returns port
PUT /network/chassies/chassis/{chassis-name}/ports/port/{port-name}

create or update an existing port
PATCH /network/chassies/chassis/{chassis-name}/ports/port/{port-name}

update an existing port
DELETE /network/chassies/chassis/{chassis-name}/ports/port/{port-name}

delete an existing port
PUT /network/chassies/chassis/{chassis-name}/ports/port/{port-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/chassies/chassis/{chassis-name}/ports/port/{port-name}/relationship-list/relationship

delete an existing relationship
PUT /network/chassies/chassis/{chassis-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/chassies/chassis/{chassis-name}/relationship-list/relationship

delete an existing relationship
GET /network/collections

returns collections
GET /network/collections/collection/{collection-id}

returns collection
PUT /network/collections/collection/{collection-id}

create or update an existing collection
PATCH /network/collections/collection/{collection-id}

update an existing collection
DELETE /network/collections/collection/{collection-id}

delete an existing collection
PUT /network/collections/collection/{collection-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/collections/collection/{collection-id}/relationship-list/relationship

delete an existing relationship
GET /network/configurations

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

returns configuration
PUT /network/configurations/configuration/{configuration-id}

create or update an existing configuration
PATCH /network/configurations/configuration/{configuration-id}

update an existing configuration
DELETE /network/configurations/configuration/{configuration-id}

delete an existing configuration
GET /network/configurations/configuration/{configuration-id}/evcs

returns evcs
GET /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}

returns evc
PUT /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}

create or update an existing evc
PATCH /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}

update an existing evc
DELETE /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}

delete an existing evc
PUT /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}/relationship-list/relationship

delete an existing relationship
GET /network/configurations/configuration/{configuration-id}/forwarder-evcs

returns forwarder-evcs
GET /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}

returns forwarder-evc
PUT /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}

create or update an existing forwarder-evc
PATCH /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}

update an existing forwarder-evc
DELETE /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}

delete an existing forwarder-evc
PUT /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/relationship-list/relationship

delete an existing relationship
GET /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/vlan-mappings

returns vlan-mappings
GET /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/vlan-mappings/vlan-mapping/{vlan-mapping-id}

returns vlan-mapping
PUT /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/vlan-mappings/vlan-mapping/{vlan-mapping-id}

create or update an existing vlan-mapping
PATCH /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/vlan-mappings/vlan-mapping/{vlan-mapping-id}

update an existing vlan-mapping
DELETE /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/vlan-mappings/vlan-mapping/{vlan-mapping-id}

delete an existing vlan-mapping
PUT /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/vlan-mappings/vlan-mapping/{vlan-mapping-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/vlan-mappings/vlan-mapping/{vlan-mapping-id}/relationship-list/relationship

delete an existing relationship
GET /network/configurations/configuration/{configuration-id}/metadata

returns metadata
GET /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}

returns metadatum
PUT /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}

create or update an existing metadatum
PATCH /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}

update an existing metadatum
DELETE /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}

delete an existing metadatum
PUT /network/configurations/configuration/{configuration-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/configurations/configuration/{configuration-id}/relationship-list/relationship

delete an existing relationship
GET /network/connectivities

returns connectivities
GET /network/connectivities/connectivity/{connectivity-id}

returns connectivity
PUT /network/connectivities/connectivity/{connectivity-id}

create or update an existing connectivity
PATCH /network/connectivities/connectivity/{connectivity-id}

update an existing connectivity
DELETE /network/connectivities/connectivity/{connectivity-id}

delete an existing connectivity
PUT /network/connectivities/connectivity/{connectivity-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/connectivities/connectivity/{connectivity-id}/relationship-list/relationship

delete an existing relationship
GET /network/devices

returns devices
GET /network/devices/device/{device-id}

returns device
PUT /network/devices/device/{device-id}

create or update an existing device
PATCH /network/devices/device/{device-id}

update an existing device
DELETE /network/devices/device/{device-id}

delete an existing device
PUT /network/devices/device/{device-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/devices/device/{device-id}/relationship-list/relationship

delete an existing relationship
GET /network/ext-aai-networks

returns ext-aai-networks
GET /network/ext-aai-networks/ext-aai-network/{aai-id}

returns ext-aai-network
PUT /network/ext-aai-networks/ext-aai-network/{aai-id}

create or update an existing ext-aai-network
PATCH /network/ext-aai-networks/ext-aai-network/{aai-id}

update an existing ext-aai-network
DELETE /network/ext-aai-networks/ext-aai-network/{aai-id}

delete an existing ext-aai-network
GET /network/ext-aai-networks/ext-aai-network/{aai-id}/esr-system-info/{esr-system-info-id}

returns esr-system-info
PUT /network/ext-aai-networks/ext-aai-network/{aai-id}/esr-system-info/{esr-system-info-id}

create or update an existing esr-system-info
PATCH /network/ext-aai-networks/ext-aai-network/{aai-id}/esr-system-info/{esr-system-info-id}

update an existing esr-system-info
DELETE /network/ext-aai-networks/ext-aai-network/{aai-id}/esr-system-info/{esr-system-info-id}

delete an existing esr-system-info
PUT /network/ext-aai-networks/ext-aai-network/{aai-id}/esr-system-info/{esr-system-info-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/ext-aai-networks/ext-aai-network/{aai-id}/esr-system-info/{esr-system-info-id}/relationship-list/relationship

delete an existing relationship
PUT /network/ext-aai-networks/ext-aai-network/{aai-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/ext-aai-networks/ext-aai-network/{aai-id}/relationship-list/relationship

delete an existing relationship
GET /network/forwarding-paths

returns forwarding-paths
GET /network/forwarding-paths/forwarding-path/{forwarding-path-id}

returns forwarding-path
PUT /network/forwarding-paths/forwarding-path/{forwarding-path-id}

create or update an existing forwarding-path
PATCH /network/forwarding-paths/forwarding-path/{forwarding-path-id}

update an existing forwarding-path
DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}

delete an existing forwarding-path
GET /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders

returns forwarders
GET /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}

returns forwarder
PUT /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}

create or update an existing forwarder
PATCH /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}

update an existing forwarder
DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}

delete an existing forwarder
PUT /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}/relationship-list/relationship

delete an existing relationship
PUT /network/forwarding-paths/forwarding-path/{forwarding-path-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}/relationship-list/relationship

delete an existing relationship
GET /network/fqdns

returns fqdns
GET /network/fqdns/fqdn/{fqdn}

returns fqdn
PUT /network/fqdns/fqdn/{fqdn}

create or update an existing fqdn
PATCH /network/fqdns/fqdn/{fqdn}

update an existing fqdn
DELETE /network/fqdns/fqdn/{fqdn}

delete an existing fqdn
PUT /network/fqdns/fqdn/{fqdn}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/fqdns/fqdn/{fqdn}/relationship-list/relationship

delete an existing relationship
GET /network/generic-vnfs

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

returns generic-vnf
PUT /network/generic-vnfs/generic-vnf/{vnf-id}

create or update an existing generic-vnf
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}

update an existing generic-vnf
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}

delete an existing generic-vnf
GET /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-groups

returns bgp-groups
GET /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-groups/bgp-group/{bgp-group-id}

returns bgp-group
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-groups/bgp-group/{bgp-group-id}

create or update an existing bgp-group
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-groups/bgp-group/{bgp-group-id}

update an existing bgp-group
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-groups/bgp-group/{bgp-group-id}

delete an existing bgp-group
GET /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-groups/bgp-group/{bgp-group-id}/address-families

returns address-families
GET /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}

returns address-family
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}

create or update an existing address-family
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}

update an existing address-family
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}

delete an existing address-family
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}/relationship-list/relationship

delete an existing relationship
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-groups/bgp-group/{bgp-group-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-groups/bgp-group/{bgp-group-id}/relationship-list/relationship

delete an existing relationship
GET /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-neighbors

returns bgp-neighbors
GET /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

returns bgp-neighbor
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

create or update an existing bgp-neighbor
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

update an existing bgp-neighbor
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

delete an existing bgp-neighbor
GET /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families

returns address-families
GET /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

returns address-family
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

create or update an existing address-family
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

update an existing address-family
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

delete an existing address-family
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}/relationship-list/relationship

delete an existing relationship
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/relationship-list/relationship

delete an existing relationship
GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements

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

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

create or update an existing entitlement
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

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

delete an existing entitlement
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

delete an existing relationship
GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces

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

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

create or update an existing l-interface
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

update an existing l-interface
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

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

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

create or update an existing l3-interface-ipv4-address-list
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

delete an existing l3-interface-ipv4-address-list
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship
GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

create or update an existing l3-interface-ipv6-address-list
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

delete an existing l3-interface-ipv6-address-list
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship
GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables

returns lcmp-unreachables
GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

returns lcmp-unreachable
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

create or update an existing lcmp-unreachable
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

update an existing lcmp-unreachable
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

delete an existing lcmp-unreachable
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

delete an existing relationship
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

delete an existing relationship
GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs

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

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

create or update an existing sriov-vf
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

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

delete an existing sriov-vf
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

delete an existing relationship
GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists

returns temporary-parameter-lists
GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

returns temporary-parameter-list
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

create or update an existing temporary-parameter-list
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

update an existing temporary-parameter-list
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

delete an existing temporary-parameter-list
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

delete an existing relationship
GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans

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

returns vlan
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

update an existing vlan
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

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

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

create or update an existing l3-interface-ipv4-address-list
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

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

see node definition for valid relationships
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

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

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

create or update an existing l3-interface-ipv6-address-list
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

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

see node definition for valid relationships
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

delete an existing relationship
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces

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

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

create or update an existing lag-interface
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

update an existing lag-interface
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

delete an existing lag-interface
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options

returns aggregated-ether-options
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}

returns aggregated-ether-option
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}

create or update an existing aggregated-ether-option
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}

update an existing aggregated-ether-option
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}

delete an existing aggregated-ether-option
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps

returns lacps
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}

returns lacp
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}

create or update an existing lacp
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}

update an existing lacp
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}

delete an existing lacp
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}/relationship-list/relationship

delete an existing relationship
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/relationship-list/relationship

delete an existing relationship
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/esis

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

returns esi
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}

create or update an existing esi
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}

update an existing esi
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}

delete an existing esi
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}/relationship-list/relationship

delete an existing relationship
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

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

returns l-interface
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

create or update an existing l-interface
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

update an existing l-interface
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

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

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

create or update an existing l3-interface-ipv4-address-list
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

delete an existing l3-interface-ipv4-address-list
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

create or update an existing l3-interface-ipv6-address-list
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

delete an existing l3-interface-ipv6-address-list
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables

returns lcmp-unreachables
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

returns lcmp-unreachable
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

create or update an existing lcmp-unreachable
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

update an existing lcmp-unreachable
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

delete an existing lcmp-unreachable
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

delete an existing relationship
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/relationship-list/relationship

delete an existing relationship
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs

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

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

create or update an existing sriov-vf
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}

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

delete an existing sriov-vf
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

delete an existing relationship
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists

returns temporary-parameter-lists
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

returns temporary-parameter-list
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

create or update an existing temporary-parameter-list
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

update an existing temporary-parameter-list
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

delete an existing temporary-parameter-list
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

delete an existing relationship
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans

returns vlans
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

returns vlan
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

update an existing vlan
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

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

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

create or update an existing l3-interface-ipv4-address-list
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

delete an existing l3-interface-ipv4-address-list
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

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

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

create or update an existing l3-interface-ipv6-address-list
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

delete an existing l3-interface-ipv6-address-list
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

delete an existing relationship
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

create or update an existing l3-interface-ipv4-address-list
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

delete an existing l3-interface-ipv4-address-list
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

create or update an existing l3-interface-ipv6-address-list
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

delete an existing l3-interface-ipv6-address-list
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

delete an existing relationship
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists

returns temporary-parameter-lists
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

returns temporary-parameter-list
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

create or update an existing temporary-parameter-list
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

update an existing temporary-parameter-list
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

delete an existing temporary-parameter-list
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

delete an existing relationship
GET /network/generic-vnfs/generic-vnf/{vnf-id}/licenses

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

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

create or update an existing license
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

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

delete an existing license
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

delete an existing relationship
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship

delete an existing relationship
GET /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules

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

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

create or update an existing vf-module
PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

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

delete an existing vf-module
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship

delete an existing relationship
GET /network/hw-components

returns hw-components
GET /network/hw-components/hw-component/{hw-component-id}

returns hw-component
PUT /network/hw-components/hw-component/{hw-component-id}

create or update an existing hw-component
PATCH /network/hw-components/hw-component/{hw-component-id}

update an existing hw-component
DELETE /network/hw-components/hw-component/{hw-component-id}

delete an existing hw-component
PUT /network/hw-components/hw-component/{hw-component-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/hw-components/hw-component/{hw-component-id}/relationship-list/relationship

delete an existing relationship
GET /network/instance-groups

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

returns instance-group
PUT /network/instance-groups/instance-group/{id}

create or update an existing instance-group
PATCH /network/instance-groups/instance-group/{id}

update an existing instance-group
DELETE /network/instance-groups/instance-group/{id}

delete an existing instance-group
PUT /network/instance-groups/instance-group/{id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/instance-groups/instance-group/{id}/relationship-list/relationship

delete an existing relationship
GET /network/interlayer-attachments

returns interlayer-attachments
GET /network/interlayer-attachments/interlayer-attachment/{id}

returns interlayer-attachment
PUT /network/interlayer-attachments/interlayer-attachment/{id}

create or update an existing interlayer-attachment
PATCH /network/interlayer-attachments/interlayer-attachment/{id}

update an existing interlayer-attachment
DELETE /network/interlayer-attachments/interlayer-attachment/{id}

delete an existing interlayer-attachment
PUT /network/interlayer-attachments/interlayer-attachment/{id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/interlayer-attachments/interlayer-attachment/{id}/relationship-list/relationship

delete an existing relationship
GET /network/ipsec-configurations

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

returns ipsec-configuration
PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

create or update an existing ipsec-configuration
PATCH /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

update an existing ipsec-configuration
DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

delete an existing ipsec-configuration
PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship

delete an existing relationship
GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers

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

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

create or update an existing vig-server
PATCH /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

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

delete an existing vig-server
PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship

delete an existing relationship
GET /network/l3-networks

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

returns l3-network
PUT /network/l3-networks/l3-network/{network-id}

create or update an existing l3-network
PATCH /network/l3-networks/l3-network/{network-id}

update an existing l3-network
DELETE /network/l3-networks/l3-network/{network-id}

delete an existing l3-network
GET /network/l3-networks/l3-network/{network-id}/aggregate-routes

returns aggregate-routes
GET /network/l3-networks/l3-network/{network-id}/aggregate-routes/aggregate-route/{agg-route-id}

returns aggregate-route
PUT /network/l3-networks/l3-network/{network-id}/aggregate-routes/aggregate-route/{agg-route-id}

create or update an existing aggregate-route
PATCH /network/l3-networks/l3-network/{network-id}/aggregate-routes/aggregate-route/{agg-route-id}

update an existing aggregate-route
DELETE /network/l3-networks/l3-network/{network-id}/aggregate-routes/aggregate-route/{agg-route-id}

delete an existing aggregate-route
PUT /network/l3-networks/l3-network/{network-id}/aggregate-routes/aggregate-route/{agg-route-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/l3-networks/l3-network/{network-id}/aggregate-routes/aggregate-route/{agg-route-id}/relationship-list/relationship

delete an existing relationship
GET /network/l3-networks/l3-network/{network-id}/ctag-assignments

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

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

create or update an existing ctag-assignment
PATCH /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

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

delete an existing ctag-assignment
PUT /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship

delete an existing relationship
PUT /network/l3-networks/l3-network/{network-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/l3-networks/l3-network/{network-id}/relationship-list/relationship

delete an existing relationship
GET /network/l3-networks/l3-network/{network-id}/segmentation-assignments

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

returns segmentation-assignment
PUT /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

create or update an existing segmentation-assignment
PATCH /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

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

delete an existing segmentation-assignment
PUT /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship

delete an existing relationship
GET /network/l3-networks/l3-network/{network-id}/subnets

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

returns subnet
PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

create or update an existing subnet
PATCH /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

update an existing subnet
DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

delete an existing subnet
GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/bgp-neighbors

returns bgp-neighbors
GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

returns bgp-neighbor
PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

create or update an existing bgp-neighbor
PATCH /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

update an existing bgp-neighbor
DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

delete an existing bgp-neighbor
GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families

returns address-families
GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

returns address-family
PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

create or update an existing address-family
PATCH /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

update an existing address-family
DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

delete an existing address-family
PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}/relationship-list/relationship

delete an existing relationship
PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/relationship-list/relationship

delete an existing relationship
GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes

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

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

create or update an existing host-route
PATCH /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

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

delete an existing host-route
PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship

delete an existing relationship
GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/ip-address-list/{ip-address}

returns ip-address-list
PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/ip-address-list/{ip-address}

create or update an existing ip-address-list
PATCH /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/ip-address-list/{ip-address}

update an existing ip-address-list
DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/ip-address-list/{ip-address}

delete an existing ip-address-list
PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/ip-address-list/{ip-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/ip-address-list/{ip-address}/relationship-list/relationship

delete an existing relationship
PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

delete an existing relationship
GET /network/label-restrictions

returns label-restrictions
GET /network/label-restrictions/label-restriction/{id}

returns label-restriction
PUT /network/label-restrictions/label-restriction/{id}

create or update an existing label-restriction
PATCH /network/label-restrictions/label-restriction/{id}

update an existing label-restriction
DELETE /network/label-restrictions/label-restriction/{id}

delete an existing label-restriction
PUT /network/label-restrictions/label-restriction/{id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/label-restrictions/label-restriction/{id}/relationship-list/relationship

delete an existing relationship
GET /network/lag-links

returns lag-links
GET /network/lag-links/lag-link/{link-name}

returns lag-link
PUT /network/lag-links/lag-link/{link-name}

create or update an existing lag-link
PATCH /network/lag-links/lag-link/{link-name}

update an existing lag-link
DELETE /network/lag-links/lag-link/{link-name}

delete an existing lag-link
PUT /network/lag-links/lag-link/{link-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/lag-links/lag-link/{link-name}/relationship-list/relationship

delete an existing relationship
GET /network/lan-port-configs

returns lan-port-configs
GET /network/lan-port-configs/lan-port-config/{lan-port-config-id}

returns lan-port-config
PUT /network/lan-port-configs/lan-port-config/{lan-port-config-id}

create or update an existing lan-port-config
PATCH /network/lan-port-configs/lan-port-config/{lan-port-config-id}

update an existing lan-port-config
DELETE /network/lan-port-configs/lan-port-config/{lan-port-config-id}

delete an existing lan-port-config
GET /network/lan-port-configs/lan-port-config/{lan-port-config-id}/dhcp-services

returns dhcp-services
GET /network/lan-port-configs/lan-port-config/{lan-port-config-id}/dhcp-services/dhcp-service/{dhcp-service-id}

returns dhcp-service
PUT /network/lan-port-configs/lan-port-config/{lan-port-config-id}/dhcp-services/dhcp-service/{dhcp-service-id}

create or update an existing dhcp-service
PATCH /network/lan-port-configs/lan-port-config/{lan-port-config-id}/dhcp-services/dhcp-service/{dhcp-service-id}

update an existing dhcp-service
DELETE /network/lan-port-configs/lan-port-config/{lan-port-config-id}/dhcp-services/dhcp-service/{dhcp-service-id}

delete an existing dhcp-service
PUT /network/lan-port-configs/lan-port-config/{lan-port-config-id}/dhcp-services/dhcp-service/{dhcp-service-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/lan-port-configs/lan-port-config/{lan-port-config-id}/dhcp-services/dhcp-service/{dhcp-service-id}/relationship-list/relationship

delete an existing relationship
PUT /network/lan-port-configs/lan-port-config/{lan-port-config-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/lan-port-configs/lan-port-config/{lan-port-config-id}/relationship-list/relationship

delete an existing relationship
GET /network/logical-links

returns logical-links
GET /network/logical-links/logical-link/{link-name}

returns logical-link
PUT /network/logical-links/logical-link/{link-name}

create or update an existing logical-link
PATCH /network/logical-links/logical-link/{link-name}

update an existing logical-link
DELETE /network/logical-links/logical-link/{link-name}

delete an existing logical-link
PUT /network/logical-links/logical-link/{link-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/logical-links/logical-link/{link-name}/relationship-list/relationship

delete an existing relationship
GET /network/mappings

returns mappings
GET /network/mappings/mapping/{mapping-id}

returns mapping
PUT /network/mappings/mapping/{mapping-id}

create or update an existing mapping
PATCH /network/mappings/mapping/{mapping-id}

update an existing mapping
DELETE /network/mappings/mapping/{mapping-id}

delete an existing mapping
PUT /network/mappings/mapping/{mapping-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/mappings/mapping/{mapping-id}/relationship-list/relationship

delete an existing relationship
GET /network/multicast-configurations

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

returns multicast-configuration
PUT /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

create or update an existing multicast-configuration
PATCH /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

update an existing multicast-configuration
DELETE /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

delete an existing multicast-configuration
PUT /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship

delete an existing relationship
GET /network/network-policies

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

returns network-policy
PUT /network/network-policies/network-policy/{network-policy-id}

create or update an existing network-policy
PATCH /network/network-policies/network-policy/{network-policy-id}

update an existing network-policy
DELETE /network/network-policies/network-policy/{network-policy-id}

delete an existing network-policy
PUT /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship

delete an existing relationship
GET /network/network-ranges

returns network-ranges
GET /network/network-ranges/network-range/{network-range-id}

returns network-range
PUT /network/network-ranges/network-range/{network-range-id}

create or update an existing network-range
PATCH /network/network-ranges/network-range/{network-range-id}

update an existing network-range
DELETE /network/network-ranges/network-range/{network-range-id}

delete an existing network-range
GET /network/network-ranges/network-range/{network-range-id}/activities

returns activities
GET /network/network-ranges/network-range/{network-range-id}/activities/activity/{activity-id}

returns activity
PUT /network/network-ranges/network-range/{network-range-id}/activities/activity/{activity-id}

create or update an existing activity
PATCH /network/network-ranges/network-range/{network-range-id}/activities/activity/{activity-id}

update an existing activity
DELETE /network/network-ranges/network-range/{network-range-id}/activities/activity/{activity-id}

delete an existing activity
GET /network/network-ranges/network-range/{network-range-id}/activities/activity/{activity-id}/activity-states

returns activity-states
GET /network/network-ranges/network-range/{network-range-id}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

returns activity-state
PUT /network/network-ranges/network-range/{network-range-id}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

create or update an existing activity-state
PATCH /network/network-ranges/network-range/{network-range-id}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

update an existing activity-state
DELETE /network/network-ranges/network-range/{network-range-id}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

delete an existing activity-state
PUT /network/network-ranges/network-range/{network-range-id}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/network-ranges/network-range/{network-range-id}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}/relationship-list/relationship

delete an existing relationship
PUT /network/network-ranges/network-range/{network-range-id}/activities/activity/{activity-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/network-ranges/network-range/{network-range-id}/activities/activity/{activity-id}/relationship-list/relationship

delete an existing relationship
PUT /network/network-ranges/network-range/{network-range-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/network-ranges/network-range/{network-range-id}/relationship-list/relationship

delete an existing relationship
GET /network/network-resources

returns network-resources
GET /network/network-resources/network-resource/{network-id}

returns network-resource
PUT /network/network-resources/network-resource/{network-id}

create or update an existing network-resource
PATCH /network/network-resources/network-resource/{network-id}

update an existing network-resource
DELETE /network/network-resources/network-resource/{network-id}

delete an existing network-resource
PUT /network/network-resources/network-resource/{network-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/network-resources/network-resource/{network-id}/relationship-list/relationship

delete an existing relationship
GET /network/network-routes

returns network-routes
GET /network/network-routes/network-route/{route-id}

returns network-route
PUT /network/network-routes/network-route/{route-id}

create or update an existing network-route
PATCH /network/network-routes/network-route/{route-id}

update an existing network-route
DELETE /network/network-routes/network-route/{route-id}

delete an existing network-route
PUT /network/network-routes/network-route/{route-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/network-routes/network-route/{route-id}/relationship-list/relationship

delete an existing relationship
GET /network/newvces

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

returns newvce
PUT /network/newvces/newvce/{vnf-id2}

create or update an existing newvce
PATCH /network/newvces/newvce/{vnf-id2}

update an existing newvce
DELETE /network/newvces/newvce/{vnf-id2}

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

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

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

create or update an existing l-interface
PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

update an existing l-interface
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

delete an existing l-interface
GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

create or update an existing l3-interface-ipv4-address-list
PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship
GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

create or update an existing l3-interface-ipv6-address-list
PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship
GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables

returns lcmp-unreachables
GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

returns lcmp-unreachable
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

create or update an existing lcmp-unreachable
PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

update an existing lcmp-unreachable
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

delete an existing lcmp-unreachable
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

delete an existing relationship
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

delete an existing relationship
GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs

returns sriov-vfs
GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

returns sriov-vf
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

create or update an existing sriov-vf
PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

update an existing sriov-vf
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

delete an existing sriov-vf
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

delete an existing relationship
GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists

returns temporary-parameter-lists
GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

returns temporary-parameter-list
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

create or update an existing temporary-parameter-list
PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

update an existing temporary-parameter-list
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

delete an existing temporary-parameter-list
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

delete an existing relationship
GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans

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

returns vlan
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan
PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

update an existing vlan
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

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

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

create or update an existing l3-interface-ipv4-address-list
PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

see node definition for valid relationships
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

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

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

create or update an existing l3-interface-ipv6-address-list
PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

see node definition for valid relationships
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

delete an existing relationship
PUT /network/newvces/newvce/{vnf-id2}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/newvces/newvce/{vnf-id2}/relationship-list/relationship

delete an existing relationship
GET /network/next-hops

returns next-hops
GET /network/next-hops/next-hop/{next-hop-id}

returns next-hop
PUT /network/next-hops/next-hop/{next-hop-id}

create or update an existing next-hop
PATCH /network/next-hops/next-hop/{next-hop-id}

update an existing next-hop
DELETE /network/next-hops/next-hop/{next-hop-id}

delete an existing next-hop
PUT /network/next-hops/next-hop/{next-hop-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/next-hops/next-hop/{next-hop-id}/relationship-list/relationship

delete an existing relationship
GET /network/physical-links

returns physical-links
GET /network/physical-links/physical-link/{link-name}

returns physical-link
PUT /network/physical-links/physical-link/{link-name}

create or update an existing physical-link
PATCH /network/physical-links/physical-link/{link-name}

update an existing physical-link
DELETE /network/physical-links/physical-link/{link-name}

delete an existing physical-link
PUT /network/physical-links/physical-link/{link-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/physical-links/physical-link/{link-name}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs

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

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

create or update an existing pnf
PATCH /network/pnfs/pnf/{pnf-name}

update an existing pnf
DELETE /network/pnfs/pnf/{pnf-name}

delete an existing pnf
GET /network/pnfs/pnf/{pnf-name}/activities

returns activities
GET /network/pnfs/pnf/{pnf-name}/activities/activity/{activity-id}

returns activity
PUT /network/pnfs/pnf/{pnf-name}/activities/activity/{activity-id}

create or update an existing activity
PATCH /network/pnfs/pnf/{pnf-name}/activities/activity/{activity-id}

update an existing activity
DELETE /network/pnfs/pnf/{pnf-name}/activities/activity/{activity-id}

delete an existing activity
GET /network/pnfs/pnf/{pnf-name}/activities/activity/{activity-id}/activity-states

returns activity-states
GET /network/pnfs/pnf/{pnf-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

returns activity-state
PUT /network/pnfs/pnf/{pnf-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

create or update an existing activity-state
PATCH /network/pnfs/pnf/{pnf-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

update an existing activity-state
DELETE /network/pnfs/pnf/{pnf-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

delete an existing activity-state
PUT /network/pnfs/pnf/{pnf-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}/relationship-list/relationship

delete an existing relationship
PUT /network/pnfs/pnf/{pnf-name}/activities/activity/{activity-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/activities/activity/{activity-id}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/bgp-groups

returns bgp-groups
GET /network/pnfs/pnf/{pnf-name}/bgp-groups/bgp-group/{bgp-group-id}

returns bgp-group
PUT /network/pnfs/pnf/{pnf-name}/bgp-groups/bgp-group/{bgp-group-id}

create or update an existing bgp-group
PATCH /network/pnfs/pnf/{pnf-name}/bgp-groups/bgp-group/{bgp-group-id}

update an existing bgp-group
DELETE /network/pnfs/pnf/{pnf-name}/bgp-groups/bgp-group/{bgp-group-id}

delete an existing bgp-group
GET /network/pnfs/pnf/{pnf-name}/bgp-groups/bgp-group/{bgp-group-id}/address-families

returns address-families
GET /network/pnfs/pnf/{pnf-name}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}

returns address-family
PUT /network/pnfs/pnf/{pnf-name}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}

create or update an existing address-family
PATCH /network/pnfs/pnf/{pnf-name}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}

update an existing address-family
DELETE /network/pnfs/pnf/{pnf-name}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}

delete an existing address-family
PUT /network/pnfs/pnf/{pnf-name}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}/relationship-list/relationship

delete an existing relationship
PUT /network/pnfs/pnf/{pnf-name}/bgp-groups/bgp-group/{bgp-group-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/bgp-groups/bgp-group/{bgp-group-id}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/bgp-neighbors

returns bgp-neighbors
GET /network/pnfs/pnf/{pnf-name}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

returns bgp-neighbor
PUT /network/pnfs/pnf/{pnf-name}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

create or update an existing bgp-neighbor
PATCH /network/pnfs/pnf/{pnf-name}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

update an existing bgp-neighbor
DELETE /network/pnfs/pnf/{pnf-name}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

delete an existing bgp-neighbor
GET /network/pnfs/pnf/{pnf-name}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families

returns address-families
GET /network/pnfs/pnf/{pnf-name}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

returns address-family
PUT /network/pnfs/pnf/{pnf-name}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

create or update an existing address-family
PATCH /network/pnfs/pnf/{pnf-name}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

update an existing address-family
DELETE /network/pnfs/pnf/{pnf-name}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

delete an existing address-family
PUT /network/pnfs/pnf/{pnf-name}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}/relationship-list/relationship

delete an existing relationship
PUT /network/pnfs/pnf/{pnf-name}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/l-interfaces

returns l-interfaces
GET /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}

returns l-interface
PUT /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}

create or update an existing l-interface
PATCH /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}

update an existing l-interface
DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}

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

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

create or update an existing l3-interface-ipv4-address-list
PATCH /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

create or update an existing l3-interface-ipv6-address-list
PATCH /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables

returns lcmp-unreachables
GET /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

returns lcmp-unreachable
PUT /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

create or update an existing lcmp-unreachable
PATCH /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

update an existing lcmp-unreachable
DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

delete an existing lcmp-unreachable
PUT /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

delete an existing relationship
PUT /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

returns sriov-vfs
GET /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

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

create or update an existing sriov-vf
PATCH /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

update an existing sriov-vf
DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

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

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists

returns temporary-parameter-lists
GET /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

returns temporary-parameter-list
PUT /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

create or update an existing temporary-parameter-list
PATCH /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

update an existing temporary-parameter-list
DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

delete an existing temporary-parameter-list
PUT /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/vlans

returns vlans
GET /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

returns vlan
PUT /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan
PATCH /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

update an existing vlan
DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

delete an existing vlan
GET /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

create or update an existing l3-interface-ipv4-address-list
PATCH /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

create or update an existing l3-interface-ipv6-address-list
PATCH /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

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

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces

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

returns lag-interface
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

create or update an existing lag-interface
PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

update an existing lag-interface
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

delete an existing lag-interface
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options

returns aggregated-ether-options
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}

returns aggregated-ether-option
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}

create or update an existing aggregated-ether-option
PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}

update an existing aggregated-ether-option
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}

delete an existing aggregated-ether-option
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps

returns lacps
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}

returns lacp
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}

create or update an existing lacp
PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}

update an existing lacp
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}

delete an existing lacp
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}/relationship-list/relationship

delete an existing relationship
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/esis

returns esis
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}

returns esi
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}

create or update an existing esi
PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}

update an existing esi
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}

delete an existing esi
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

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

returns l-interface
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

create or update an existing l-interface
PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

update an existing l-interface
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

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

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

create or update an existing l3-interface-ipv4-address-list
PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

create or update an existing l3-interface-ipv6-address-list
PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables

returns lcmp-unreachables
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

returns lcmp-unreachable
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

create or update an existing lcmp-unreachable
PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

update an existing lcmp-unreachable
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

delete an existing lcmp-unreachable
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

delete an existing relationship
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs

returns sriov-vfs
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}

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

create or update an existing sriov-vf
PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}

update an existing sriov-vf
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}

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

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists

returns temporary-parameter-lists
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

returns temporary-parameter-list
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

create or update an existing temporary-parameter-list
PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

update an existing temporary-parameter-list
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

delete an existing temporary-parameter-list
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans

returns vlans
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

returns vlan
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan
PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

update an existing vlan
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

delete an existing vlan
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

create or update an existing l3-interface-ipv4-address-list
PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

create or update an existing l3-interface-ipv6-address-list
PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

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

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

create or update an existing l3-interface-ipv4-address-list
PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

create or update an existing l3-interface-ipv6-address-list
PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists

returns temporary-parameter-lists
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

returns temporary-parameter-list
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

create or update an existing temporary-parameter-list
PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

update an existing temporary-parameter-list
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

delete an existing temporary-parameter-list
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/p-interfaces

returns p-interfaces
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

returns p-interface
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

create or update an existing p-interface
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

update an existing p-interface
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

delete an existing p-interface
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/activities

returns activities
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}

returns activity
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}

create or update an existing activity
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}

update an existing activity
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}

delete an existing activity
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states

returns activity-states
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

returns activity-state
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

create or update an existing activity-state
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

update an existing activity-state
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

delete an existing activity-state
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}/relationship-list/relationship

delete an existing relationship
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes

returns bandwidth-attributes
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}

returns bandwidth-attribute
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}

create or update an existing bandwidth-attribute
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}

update an existing bandwidth-attribute
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}

delete an existing bandwidth-attribute
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map

returns available-bandwidth-map
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}

returns available-bandwidth
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}

create or update an existing available-bandwidth
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}

update an existing available-bandwidth
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}

delete an existing available-bandwidth
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}/relationship-list/relationship

delete an existing relationship
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/gig-ether-options

returns gig-ether-options
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}

returns gig-ether-option
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}

create or update an existing gig-ether-option
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}

update an existing gig-ether-option
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}

delete an existing gig-ether-option
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/hold-timers

returns hold-timers
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/hold-timers/hold-timer/{hold-timer-id}

returns hold-timer
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/hold-timers/hold-timer/{hold-timer-id}

create or update an existing hold-timer
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/hold-timers/hold-timer/{hold-timer-id}

update an existing hold-timer
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/hold-timers/hold-timer/{hold-timer-id}

delete an existing hold-timer
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/hold-timers/hold-timer/{hold-timer-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/hold-timers/hold-timer/{hold-timer-id}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces

returns l-interfaces
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

returns l-interface
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

create or update an existing l-interface
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

update an existing l-interface
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

delete an existing l-interface
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

create or update an existing l3-interface-ipv4-address-list
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

create or update an existing l3-interface-ipv6-address-list
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables

returns lcmp-unreachables
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

returns lcmp-unreachable
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

create or update an existing lcmp-unreachable
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

update an existing lcmp-unreachable
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

delete an existing lcmp-unreachable
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

delete an existing relationship
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs

returns sriov-vfs
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}

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

create or update an existing sriov-vf
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}

update an existing sriov-vf
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}

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

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists

returns temporary-parameter-lists
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

returns temporary-parameter-list
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

create or update an existing temporary-parameter-list
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

update an existing temporary-parameter-list
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

delete an existing temporary-parameter-list
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans

returns vlans
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

returns vlan
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

update an existing vlan
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

delete an existing vlan
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

create or update an existing l3-interface-ipv4-address-list
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

create or update an existing l3-interface-ipv6-address-list
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

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

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

create or update an existing l3-interface-ipv4-address-list
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

create or update an existing l3-interface-ipv6-address-list
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs

returns sriov-pfs
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

returns sriov-pf
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

create or update an existing sriov-pf
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

update an existing sriov-pf
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

delete an existing sriov-pf
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists

returns temporary-parameter-lists
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

returns temporary-parameter-list
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

create or update an existing temporary-parameter-list
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

update an existing temporary-parameter-list
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

delete an existing temporary-parameter-list
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

delete an existing relationship
PUT /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/software-versions

returns software-versions
GET /network/pnfs/pnf/{pnf-name}/software-versions/software-version/{software-version-id}

returns software-version
PUT /network/pnfs/pnf/{pnf-name}/software-versions/software-version/{software-version-id}

create or update an existing software-version
PATCH /network/pnfs/pnf/{pnf-name}/software-versions/software-version/{software-version-id}

update an existing software-version
DELETE /network/pnfs/pnf/{pnf-name}/software-versions/software-version/{software-version-id}

delete an existing software-version
GET /network/pnfs/pnf/{pnf-name}/vrfs

returns vrfs
GET /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}

returns vrf
PUT /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}

create or update an existing vrf
PATCH /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}

update an existing vrf
DELETE /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}

delete an existing vrf
GET /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/aggregate-routes

returns aggregate-routes
GET /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/aggregate-routes/aggregate-route/{agg-route-id}

returns aggregate-route
PUT /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/aggregate-routes/aggregate-route/{agg-route-id}

create or update an existing aggregate-route
PATCH /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/aggregate-routes/aggregate-route/{agg-route-id}

update an existing aggregate-route
DELETE /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/aggregate-routes/aggregate-route/{agg-route-id}

delete an existing aggregate-route
PUT /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/aggregate-routes/aggregate-route/{agg-route-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/aggregate-routes/aggregate-route/{agg-route-id}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-groups

returns bgp-groups
GET /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-groups/bgp-group/{bgp-group-id}

returns bgp-group
PUT /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-groups/bgp-group/{bgp-group-id}

create or update an existing bgp-group
PATCH /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-groups/bgp-group/{bgp-group-id}

update an existing bgp-group
DELETE /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-groups/bgp-group/{bgp-group-id}

delete an existing bgp-group
GET /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-groups/bgp-group/{bgp-group-id}/address-families

returns address-families
GET /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}

returns address-family
PUT /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}

create or update an existing address-family
PATCH /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}

update an existing address-family
DELETE /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}

delete an existing address-family
PUT /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}/relationship-list/relationship

delete an existing relationship
PUT /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-groups/bgp-group/{bgp-group-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-groups/bgp-group/{bgp-group-id}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-neighbors

returns bgp-neighbors
GET /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

returns bgp-neighbor
PUT /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

create or update an existing bgp-neighbor
PATCH /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

update an existing bgp-neighbor
DELETE /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

delete an existing bgp-neighbor
GET /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families

returns address-families
GET /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

returns address-family
PUT /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

create or update an existing address-family
PATCH /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

update an existing address-family
DELETE /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

delete an existing address-family
PUT /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}/relationship-list/relationship

delete an existing relationship
PUT /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/relationship-list/relationship

delete an existing relationship
PUT /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/route-targets

returns route-targets
GET /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/route-targets/route-target/{global-route-target}/{route-target-role}

returns route-target
PUT /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/route-targets/route-target/{global-route-target}/{route-target-role}

create or update an existing route-target
PATCH /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/route-targets/route-target/{global-route-target}/{route-target-role}

update an existing route-target
DELETE /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/route-targets/route-target/{global-route-target}/{route-target-role}

delete an existing route-target
PUT /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship

delete an existing relationship
GET /network/route-table-references

returns route-table-references
GET /network/route-table-references/route-table-reference/{route-table-reference-id}

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

create or update an existing route-table-reference
PATCH /network/route-table-references/route-table-reference/{route-table-reference-id}

update an existing route-table-reference
DELETE /network/route-table-references/route-table-reference/{route-table-reference-id}

delete an existing route-table-reference
PUT /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

delete an existing relationship
GET /network/sdwan-vpns

returns sdwan-vpns
GET /network/sdwan-vpns/sdwan-vpn/{sdwan-vpn-id}

returns sdwan-vpn
PUT /network/sdwan-vpns/sdwan-vpn/{sdwan-vpn-id}

create or update an existing sdwan-vpn
PATCH /network/sdwan-vpns/sdwan-vpn/{sdwan-vpn-id}

update an existing sdwan-vpn
DELETE /network/sdwan-vpns/sdwan-vpn/{sdwan-vpn-id}

delete an existing sdwan-vpn
PUT /network/sdwan-vpns/sdwan-vpn/{sdwan-vpn-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/sdwan-vpns/sdwan-vpn/{sdwan-vpn-id}/relationship-list/relationship

delete an existing relationship
GET /network/site-pair-sets

returns site-pair-sets
GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}

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

create or update an existing site-pair-set
PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}

update an existing site-pair-set
DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}

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

see node definition for valid relationships
DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship

delete an existing relationship
GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances

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

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

create or update an existing routing-instance
PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

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

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

see node definition for valid relationships
DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship

delete an existing relationship
GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs

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

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

create or update an existing site-pair
PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}

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

delete an existing site-pair
GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service

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

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

create or update an existing class-of-service
PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}

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

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

see node definition for valid relationships
DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}/relationship-list/relationship

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

see node definition for valid relationships
DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/relationship-list/relationship

delete an existing relationship
GET /network/site-resources

returns site-resources
GET /network/site-resources/site-resource/{site-resource-id}

returns site-resource
PUT /network/site-resources/site-resource/{site-resource-id}

create or update an existing site-resource
PATCH /network/site-resources/site-resource/{site-resource-id}

update an existing site-resource
DELETE /network/site-resources/site-resource/{site-resource-id}

delete an existing site-resource
PUT /network/site-resources/site-resource/{site-resource-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/site-resources/site-resource/{site-resource-id}/relationship-list/relationship

delete an existing relationship
GET /network/sw-components

returns sw-components
GET /network/sw-components/sw-component/{sw-component-id}

returns sw-component
PUT /network/sw-components/sw-component/{sw-component-id}

create or update an existing sw-component
PATCH /network/sw-components/sw-component/{sw-component-id}

update an existing sw-component
DELETE /network/sw-components/sw-component/{sw-component-id}

delete an existing sw-component
PUT /network/sw-components/sw-component/{sw-component-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/sw-components/sw-component/{sw-component-id}/relationship-list/relationship

delete an existing relationship
GET /network/te-link-attributes

returns te-link-attributes
GET /network/te-link-attributes/te-link-attribute/{id}

returns te-link-attribute
PUT /network/te-link-attributes/te-link-attribute/{id}

create or update an existing te-link-attribute
PATCH /network/te-link-attributes/te-link-attribute/{id}

update an existing te-link-attribute
DELETE /network/te-link-attributes/te-link-attribute/{id}

delete an existing te-link-attribute
PUT /network/te-link-attributes/te-link-attribute/{id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/te-link-attributes/te-link-attribute/{id}/relationship-list/relationship

delete an existing relationship
GET /network/tunnel-termination-points

returns tunnel-termination-points
GET /network/tunnel-termination-points/tunnel-termination-point/{ttp-id}

returns tunnel-termination-point
PUT /network/tunnel-termination-points/tunnel-termination-point/{ttp-id}

create or update an existing tunnel-termination-point
PATCH /network/tunnel-termination-points/tunnel-termination-point/{ttp-id}

update an existing tunnel-termination-point
DELETE /network/tunnel-termination-points/tunnel-termination-point/{ttp-id}

delete an existing tunnel-termination-point
PUT /network/tunnel-termination-points/tunnel-termination-point/{ttp-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/tunnel-termination-points/tunnel-termination-point/{ttp-id}/relationship-list/relationship

delete an existing relationship
GET /network/unis

returns unis
GET /network/unis/uni/{id}

returns uni
PUT /network/unis/uni/{id}

create or update an existing uni
PATCH /network/unis/uni/{id}

update an existing uni
DELETE /network/unis/uni/{id}

delete an existing uni
PUT /network/unis/uni/{id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/unis/uni/{id}/relationship-list/relationship

delete an existing relationship
GET /network/vces

returns vces
GET /network/vces/vce/{vnf-id}

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

create or update an existing vce
PATCH /network/vces/vce/{vnf-id}

update an existing vce
DELETE /network/vces/vce/{vnf-id}

delete an existing vce
GET /network/vces/vce/{vnf-id}/entitlements

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

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

create or update an existing entitlement
PATCH /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

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

delete an existing entitlement
PUT /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

delete an existing relationship
GET /network/vces/vce/{vnf-id}/licenses

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

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

create or update an existing license
PATCH /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

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

delete an existing license
PUT /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

delete an existing relationship
GET /network/vces/vce/{vnf-id}/port-groups

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

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

create or update an existing port-group
PATCH /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

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

delete an existing port-group
GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags

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

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

create or update an existing cvlan-tag-entry
PATCH /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

update an existing cvlan-tag-entry
DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

delete an existing cvlan-tag-entry
PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship

delete an existing relationship
PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship

delete an existing relationship
PUT /network/vces/vce/{vnf-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/vces/vce/{vnf-id}/relationship-list/relationship

delete an existing relationship
GET /network/vnfcs

returns vnfcs
GET /network/vnfcs/vnfc/{vnfc-name}

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

create or update an existing vnfc
PATCH /network/vnfcs/vnfc/{vnfc-name}

update an existing vnfc
DELETE /network/vnfcs/vnfc/{vnfc-name}

delete an existing vnfc
GET /network/vnfcs/vnfc/{vnfc-name}/cps

returns cps
GET /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}

returns cp
PUT /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}

create or update an existing cp
PATCH /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}

update an existing cp
DELETE /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}

delete an existing cp
GET /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list
PUT /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list
PATCH /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
DELETE /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list
PUT /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship
GET /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list
PUT /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list
PATCH /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
DELETE /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list
PUT /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship
PUT /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/relationship-list/relationship

delete an existing relationship
GET /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list
PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list
PATCH /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list
PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship
GET /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list
PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list
PATCH /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list
PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship
PUT /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship

delete an existing relationship
GET /network/vpls-pes

returns vpls-pes
GET /network/vpls-pes/vpls-pe/{equipment-name}

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

create or update an existing vpls-pe
PATCH /network/vpls-pes/vpls-pe/{equipment-name}

update an existing vpls-pe
DELETE /network/vpls-pes/vpls-pe/{equipment-name}

delete an existing vpls-pe
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces

returns lag-interfaces
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

returns lag-interface
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

create or update an existing lag-interface
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

update an existing lag-interface
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

delete an existing lag-interface
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options

returns aggregated-ether-options
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}

returns aggregated-ether-option
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}

create or update an existing aggregated-ether-option
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}

update an existing aggregated-ether-option
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}

delete an existing aggregated-ether-option
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps

returns lacps
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}

returns lacp
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}

create or update an existing lacp
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}

update an existing lacp
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}

delete an existing lacp
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}/relationship-list/relationship

delete an existing relationship
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/relationship-list/relationship

delete an existing relationship
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/esis

returns esis
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}

returns esi
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}

create or update an existing esi
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}

update an existing esi
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}

delete an existing esi
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}/relationship-list/relationship

delete an existing relationship
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

returns l-interfaces
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

returns l-interface
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

create or update an existing l-interface
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

update an existing l-interface
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

delete an existing l-interface
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

create or update an existing l3-interface-ipv4-address-list
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

create or update an existing l3-interface-ipv6-address-list
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables

returns lcmp-unreachables
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

returns lcmp-unreachable
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

create or update an existing lcmp-unreachable
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

update an existing lcmp-unreachable
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

delete an existing lcmp-unreachable
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

delete an existing relationship
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/relationship-list/relationship

delete an existing relationship
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs

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

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

create or update an existing sriov-vf
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}

update an existing sriov-vf
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}

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

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

delete an existing relationship
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists

returns temporary-parameter-lists
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

returns temporary-parameter-list
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

create or update an existing temporary-parameter-list
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

update an existing temporary-parameter-list
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

delete an existing temporary-parameter-list
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

delete an existing relationship
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans

returns vlans
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

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

create or update an existing vlan
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

update an existing vlan
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

delete an existing vlan
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

create or update an existing l3-interface-ipv4-address-list
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

create or update an existing l3-interface-ipv6-address-list
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

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

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

delete an existing relationship
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

create or update an existing l3-interface-ipv4-address-list
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

create or update an existing l3-interface-ipv6-address-list
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

delete an existing relationship
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists

returns temporary-parameter-lists
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

returns temporary-parameter-list
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

create or update an existing temporary-parameter-list
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

update an existing temporary-parameter-list
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

delete an existing temporary-parameter-list
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

delete an existing relationship
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces

returns p-interfaces
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

returns p-interface
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

create or update an existing p-interface
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

update an existing p-interface
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

delete an existing p-interface
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/activities

returns activities
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}

returns activity
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}

create or update an existing activity
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}

update an existing activity
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}

delete an existing activity
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states

returns activity-states
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

returns activity-state
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

create or update an existing activity-state
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

update an existing activity-state
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

delete an existing activity-state
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}/relationship-list/relationship

delete an existing relationship
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/relationship-list/relationship

delete an existing relationship
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes

returns bandwidth-attributes
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}

returns bandwidth-attribute
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}

create or update an existing bandwidth-attribute
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}

update an existing bandwidth-attribute
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}

delete an existing bandwidth-attribute
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map

returns available-bandwidth-map
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}

returns available-bandwidth
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}

create or update an existing available-bandwidth
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}

update an existing available-bandwidth
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}

delete an existing available-bandwidth
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}/relationship-list/relationship

delete an existing relationship
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/relationship-list/relationship

delete an existing relationship
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/gig-ether-options

returns gig-ether-options
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}

returns gig-ether-option
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}

create or update an existing gig-ether-option
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}

update an existing gig-ether-option
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}

delete an existing gig-ether-option
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}/relationship-list/relationship

delete an existing relationship
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/hold-timers

returns hold-timers
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/hold-timers/hold-timer/{hold-timer-id}

returns hold-timer
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/hold-timers/hold-timer/{hold-timer-id}

create or update an existing hold-timer
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/hold-timers/hold-timer/{hold-timer-id}

update an existing hold-timer
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/hold-timers/hold-timer/{hold-timer-id}

delete an existing hold-timer
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/hold-timers/hold-timer/{hold-timer-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/hold-timers/hold-timer/{hold-timer-id}/relationship-list/relationship

delete an existing relationship
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces

returns l-interfaces
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

returns l-interface
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

create or update an existing l-interface
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

update an existing l-interface
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

delete an existing l-interface
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

create or update an existing l3-interface-ipv4-address-list
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

create or update an existing l3-interface-ipv6-address-list
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables

returns lcmp-unreachables
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

returns lcmp-unreachable
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

create or update an existing lcmp-unreachable
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

update an existing lcmp-unreachable
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

delete an existing lcmp-unreachable
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

delete an existing relationship
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/relationship-list/relationship

delete an existing relationship
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs

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

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

create or update an existing sriov-vf
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}

update an existing sriov-vf
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}

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

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

delete an existing relationship
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists

returns temporary-parameter-lists
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

returns temporary-parameter-list
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

create or update an existing temporary-parameter-list
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

update an existing temporary-parameter-list
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

delete an existing temporary-parameter-list
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

delete an existing relationship
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans

returns vlans
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

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

create or update an existing vlan
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

update an existing vlan
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

delete an existing vlan
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

create or update an existing l3-interface-ipv4-address-list
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

create or update an existing l3-interface-ipv6-address-list
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

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

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

delete an existing relationship
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

create or update an existing l3-interface-ipv4-address-list
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

create or update an existing l3-interface-ipv6-address-list
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

delete an existing relationship
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs

returns sriov-pfs
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

returns sriov-pf
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

create or update an existing sriov-pf
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

update an existing sriov-pf
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

delete an existing sriov-pf
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

delete an existing relationship
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists

returns temporary-parameter-lists
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

returns temporary-parameter-list
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

create or update an existing temporary-parameter-list
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

update an existing temporary-parameter-list
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

delete an existing temporary-parameter-list
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

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

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship

delete an existing relationship
GET /network/vpn-bindings

returns vpn-bindings
GET /network/vpn-bindings/vpn-binding/{vpn-id}

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

create or update an existing vpn-binding
PATCH /network/vpn-bindings/vpn-binding/{vpn-id}

update an existing vpn-binding
DELETE /network/vpn-bindings/vpn-binding/{vpn-id}

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

see node definition for valid relationships
DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship

delete an existing relationship
GET /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets

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

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

create or update an existing route-target
PATCH /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

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

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

see node definition for valid relationships
DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship

delete an existing relationship
GET /network/wan-port-configs

returns wan-port-configs
GET /network/wan-port-configs/wan-port-config/{wan-port-config-id}

returns wan-port-config
PUT /network/wan-port-configs/wan-port-config/{wan-port-config-id}

create or update an existing wan-port-config
PATCH /network/wan-port-configs/wan-port-config/{wan-port-config-id}

update an existing wan-port-config
DELETE /network/wan-port-configs/wan-port-config/{wan-port-config-id}

delete an existing wan-port-config
PUT /network/wan-port-configs/wan-port-config/{wan-port-config-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/wan-port-configs/wan-port-config/{wan-port-config-id}/relationship-list/relationship

delete an existing relationship
GET /network/zones

returns zones
GET /network/zones/zone/{zone-id}

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

create or update an existing zone
PATCH /network/zones/zone/{zone-id}

update an existing zone
DELETE /network/zones/zone/{zone-id}

delete an existing zone
PUT /network/zones/zone/{zone-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/zones/zone/{zone-id}/relationship-list/relationship

delete an existing relationship
GET /network/zones/zone/{zone-id}/subnets

returns subnets
GET /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}

returns subnet
PUT /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}

create or update an existing subnet
PATCH /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}

update an existing subnet
DELETE /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}

delete an existing subnet
GET /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/bgp-neighbors

returns bgp-neighbors
GET /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

returns bgp-neighbor
PUT /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

create or update an existing bgp-neighbor
PATCH /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

update an existing bgp-neighbor
DELETE /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

delete an existing bgp-neighbor
GET /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families

returns address-families
GET /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

returns address-family
PUT /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

create or update an existing address-family
PATCH /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

update an existing address-family
DELETE /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

delete an existing address-family
PUT /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}/relationship-list/relationship

delete an existing relationship
PUT /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/relationship-list/relationship

delete an existing relationship
GET /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/host-routes

returns host-routes
GET /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

returns host-route
PUT /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

create or update an existing host-route
PATCH /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

update an existing host-route
DELETE /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

delete an existing host-route
PUT /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship

delete an existing relationship
GET /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/ip-address-list/{ip-address}

returns ip-address-list
PUT /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/ip-address-list/{ip-address}

create or update an existing ip-address-list
PATCH /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/ip-address-list/{ip-address}

update an existing ip-address-list
DELETE /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/ip-address-list/{ip-address}

delete an existing ip-address-list
PUT /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/ip-address-list/{ip-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/ip-address-list/{ip-address}/relationship-list/relationship

delete an existing relationship
PUT /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

delete an existing relationship
GET /network/zones/zone/{zone-id}/vlan-ranges

returns vlan-ranges
GET /network/zones/zone/{zone-id}/vlan-ranges/vlan-range/{vlan-range-id}

returns vlan-range
PUT /network/zones/zone/{zone-id}/vlan-ranges/vlan-range/{vlan-range-id}

create or update an existing vlan-range
PATCH /network/zones/zone/{zone-id}/vlan-ranges/vlan-range/{vlan-range-id}

update an existing vlan-range
DELETE /network/zones/zone/{zone-id}/vlan-ranges/vlan-range/{vlan-range-id}

delete an existing vlan-range
PUT /network/zones/zone/{zone-id}/vlan-ranges/vlan-range/{vlan-range-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/zones/zone/{zone-id}/vlan-ranges/vlan-range/{vlan-range-id}/relationship-list/relationship

delete an existing relationship
GET /network/zones/zone/{zone-id}/vlan-ranges/vlan-range/{vlan-range-id}/vlan-tags

returns vlan-tags
GET /network/zones/zone/{zone-id}/vlan-ranges/vlan-range/{vlan-range-id}/vlan-tags/vlan-tag/{vlan-tag-id}

returns vlan-tag
PUT /network/zones/zone/{zone-id}/vlan-ranges/vlan-range/{vlan-range-id}/vlan-tags/vlan-tag/{vlan-tag-id}

create or update an existing vlan-tag
PATCH /network/zones/zone/{zone-id}/vlan-ranges/vlan-range/{vlan-range-id}/vlan-tags/vlan-tag/{vlan-tag-id}

update an existing vlan-tag
DELETE /network/zones/zone/{zone-id}/vlan-ranges/vlan-range/{vlan-range-id}/vlan-tags/vlan-tag/{vlan-tag-id}

delete an existing vlan-tag
PUT /network/zones/zone/{zone-id}/vlan-ranges/vlan-range/{vlan-range-id}/vlan-tags/vlan-tag/{vlan-tag-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /network/zones/zone/{zone-id}/vlan-ranges/vlan-range/{vlan-range-id}/vlan-tags/vlan-tag/{vlan-tag-id}/relationship-list/relationship

delete an existing relationship

Tag: Common

OperationDescription
GET /common/class-map-members

returns class-map-members
GET /common/class-map-members/class-map-member/{class-map-member-id}

returns class-map-member
PUT /common/class-map-members/class-map-member/{class-map-member-id}

create or update an existing class-map-member
PATCH /common/class-map-members/class-map-member/{class-map-member-id}

update an existing class-map-member
DELETE /common/class-map-members/class-map-member/{class-map-member-id}

delete an existing class-map-member
PUT /common/class-map-members/class-map-member/{class-map-member-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /common/class-map-members/class-map-member/{class-map-member-id}/relationship-list/relationship

delete an existing relationship
GET /common/class-maps

returns class-maps
GET /common/class-maps/class-map/{class-map-id}

returns class-map
PUT /common/class-maps/class-map/{class-map-id}

create or update an existing class-map
PATCH /common/class-maps/class-map/{class-map-id}

update an existing class-map
DELETE /common/class-maps/class-map/{class-map-id}

delete an existing class-map
PUT /common/class-maps/class-map/{class-map-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /common/class-maps/class-map/{class-map-id}/relationship-list/relationship

delete an existing relationship
GET /common/contacts

returns contacts
GET /common/contacts/contact/{contact-name}

returns contact
PUT /common/contacts/contact/{contact-name}

create or update an existing contact
PATCH /common/contacts/contact/{contact-name}

update an existing contact
DELETE /common/contacts/contact/{contact-name}

delete an existing contact
PUT /common/contacts/contact/{contact-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /common/contacts/contact/{contact-name}/relationship-list/relationship

delete an existing relationship
GET /common/hardware-catalog-items

returns hardware-catalog-items
GET /common/hardware-catalog-items/hardware-catalog-item/{item-name}

returns hardware-catalog-item
PUT /common/hardware-catalog-items/hardware-catalog-item/{item-name}

create or update an existing hardware-catalog-item
PATCH /common/hardware-catalog-items/hardware-catalog-item/{item-name}

update an existing hardware-catalog-item
DELETE /common/hardware-catalog-items/hardware-catalog-item/{item-name}

delete an existing hardware-catalog-item
PUT /common/hardware-catalog-items/hardware-catalog-item/{item-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /common/hardware-catalog-items/hardware-catalog-item/{item-name}/relationship-list/relationship

delete an existing relationship
GET /common/object-groups

returns object-groups
GET /common/object-groups/object-group/{object-group-id}

returns object-group
PUT /common/object-groups/object-group/{object-group-id}

create or update an existing object-group
PATCH /common/object-groups/object-group/{object-group-id}

update an existing object-group
DELETE /common/object-groups/object-group/{object-group-id}

delete an existing object-group
GET /common/object-groups/object-group/{object-group-id}/community-list/{community-value}

returns community-list
PUT /common/object-groups/object-group/{object-group-id}/community-list/{community-value}

create or update an existing community-list
PATCH /common/object-groups/object-group/{object-group-id}/community-list/{community-value}

update an existing community-list
DELETE /common/object-groups/object-group/{object-group-id}/community-list/{community-value}

delete an existing community-list
PUT /common/object-groups/object-group/{object-group-id}/community-list/{community-value}/relationship-list/relationship

see node definition for valid relationships
DELETE /common/object-groups/object-group/{object-group-id}/community-list/{community-value}/relationship-list/relationship

delete an existing relationship
GET /common/object-groups/object-group/{object-group-id}/ip-address-list/{ip-address}

returns ip-address-list
PUT /common/object-groups/object-group/{object-group-id}/ip-address-list/{ip-address}

create or update an existing ip-address-list
PATCH /common/object-groups/object-group/{object-group-id}/ip-address-list/{ip-address}

update an existing ip-address-list
DELETE /common/object-groups/object-group/{object-group-id}/ip-address-list/{ip-address}

delete an existing ip-address-list
PUT /common/object-groups/object-group/{object-group-id}/ip-address-list/{ip-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /common/object-groups/object-group/{object-group-id}/ip-address-list/{ip-address}/relationship-list/relationship

delete an existing relationship
GET /common/object-groups/object-group/{object-group-id}/port-list/{port}

returns port-list
PUT /common/object-groups/object-group/{object-group-id}/port-list/{port}

create or update an existing port-list
PATCH /common/object-groups/object-group/{object-group-id}/port-list/{port}

update an existing port-list
DELETE /common/object-groups/object-group/{object-group-id}/port-list/{port}

delete an existing port-list
PUT /common/object-groups/object-group/{object-group-id}/port-list/{port}/relationship-list/relationship

see node definition for valid relationships
DELETE /common/object-groups/object-group/{object-group-id}/port-list/{port}/relationship-list/relationship

delete an existing relationship
PUT /common/object-groups/object-group/{object-group-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /common/object-groups/object-group/{object-group-id}/relationship-list/relationship

delete an existing relationship
GET /common/object-groups/object-group/{object-group-id}/selector-list/{selector}

returns selector-list
PUT /common/object-groups/object-group/{object-group-id}/selector-list/{selector}

create or update an existing selector-list
PATCH /common/object-groups/object-group/{object-group-id}/selector-list/{selector}

update an existing selector-list
DELETE /common/object-groups/object-group/{object-group-id}/selector-list/{selector}

delete an existing selector-list
PUT /common/object-groups/object-group/{object-group-id}/selector-list/{selector}/relationship-list/relationship

see node definition for valid relationships
DELETE /common/object-groups/object-group/{object-group-id}/selector-list/{selector}/relationship-list/relationship

delete an existing relationship
GET /common/parameter-lists

returns parameter-lists
GET /common/parameter-lists/parameter-list/{parameter-list-id}

returns parameter-list
PUT /common/parameter-lists/parameter-list/{parameter-list-id}

create or update an existing parameter-list
PATCH /common/parameter-lists/parameter-list/{parameter-list-id}

update an existing parameter-list
DELETE /common/parameter-lists/parameter-list/{parameter-list-id}

delete an existing parameter-list
PUT /common/parameter-lists/parameter-list/{parameter-list-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /common/parameter-lists/parameter-list/{parameter-list-id}/relationship-list/relationship

delete an existing relationship
GET /common/policies

returns policies
GET /common/policies/policy/{policy-id}

returns policy
PUT /common/policies/policy/{policy-id}

create or update an existing policy
PATCH /common/policies/policy/{policy-id}

update an existing policy
DELETE /common/policies/policy/{policy-id}

delete an existing policy
GET /common/policies/policy/{policy-id}/ip-address-list/{ip-address}

returns ip-address-list
PUT /common/policies/policy/{policy-id}/ip-address-list/{ip-address}

create or update an existing ip-address-list
PATCH /common/policies/policy/{policy-id}/ip-address-list/{ip-address}

update an existing ip-address-list
DELETE /common/policies/policy/{policy-id}/ip-address-list/{ip-address}

delete an existing ip-address-list
PUT /common/policies/policy/{policy-id}/ip-address-list/{ip-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /common/policies/policy/{policy-id}/ip-address-list/{ip-address}/relationship-list/relationship

delete an existing relationship
PUT /common/policies/policy/{policy-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /common/policies/policy/{policy-id}/relationship-list/relationship

delete an existing relationship
GET /common/policies/policy/{policy-id}/rules

returns rules
GET /common/policies/policy/{policy-id}/rules/rule/{rule-id}

returns rule
PUT /common/policies/policy/{policy-id}/rules/rule/{rule-id}

create or update an existing rule
PATCH /common/policies/policy/{policy-id}/rules/rule/{rule-id}

update an existing rule
DELETE /common/policies/policy/{policy-id}/rules/rule/{rule-id}

delete an existing rule
GET /common/policies/policy/{policy-id}/rules/rule/{rule-id}/ip-address-list/{ip-address}

returns ip-address-list
PUT /common/policies/policy/{policy-id}/rules/rule/{rule-id}/ip-address-list/{ip-address}

create or update an existing ip-address-list
PATCH /common/policies/policy/{policy-id}/rules/rule/{rule-id}/ip-address-list/{ip-address}

update an existing ip-address-list
DELETE /common/policies/policy/{policy-id}/rules/rule/{rule-id}/ip-address-list/{ip-address}

delete an existing ip-address-list
PUT /common/policies/policy/{policy-id}/rules/rule/{rule-id}/ip-address-list/{ip-address}/relationship-list/relationship

see node definition for valid relationships
DELETE /common/policies/policy/{policy-id}/rules/rule/{rule-id}/ip-address-list/{ip-address}/relationship-list/relationship

delete an existing relationship
GET /common/policies/policy/{policy-id}/rules/rule/{rule-id}/metadata

returns metadata
GET /common/policies/policy/{policy-id}/rules/rule/{rule-id}/metadata/metadatum/{metaname}

returns metadatum
PUT /common/policies/policy/{policy-id}/rules/rule/{rule-id}/metadata/metadatum/{metaname}

create or update an existing metadatum
PATCH /common/policies/policy/{policy-id}/rules/rule/{rule-id}/metadata/metadatum/{metaname}

update an existing metadatum
DELETE /common/policies/policy/{policy-id}/rules/rule/{rule-id}/metadata/metadatum/{metaname}

delete an existing metadatum
GET /common/policies/policy/{policy-id}/rules/rule/{rule-id}/port-list/{port}

returns port-list
PUT /common/policies/policy/{policy-id}/rules/rule/{rule-id}/port-list/{port}

create or update an existing port-list
PATCH /common/policies/policy/{policy-id}/rules/rule/{rule-id}/port-list/{port}

update an existing port-list
DELETE /common/policies/policy/{policy-id}/rules/rule/{rule-id}/port-list/{port}

delete an existing port-list
PUT /common/policies/policy/{policy-id}/rules/rule/{rule-id}/port-list/{port}/relationship-list/relationship

see node definition for valid relationships
DELETE /common/policies/policy/{policy-id}/rules/rule/{rule-id}/port-list/{port}/relationship-list/relationship

delete an existing relationship
PUT /common/policies/policy/{policy-id}/rules/rule/{rule-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /common/policies/policy/{policy-id}/rules/rule/{rule-id}/relationship-list/relationship

delete an existing relationship
GET /common/policies/policy/{policy-id}/rules/rule/{rule-id}/selector-list/{selector}

returns selector-list
PUT /common/policies/policy/{policy-id}/rules/rule/{rule-id}/selector-list/{selector}

create or update an existing selector-list
PATCH /common/policies/policy/{policy-id}/rules/rule/{rule-id}/selector-list/{selector}

update an existing selector-list
DELETE /common/policies/policy/{policy-id}/rules/rule/{rule-id}/selector-list/{selector}

delete an existing selector-list
PUT /common/policies/policy/{policy-id}/rules/rule/{rule-id}/selector-list/{selector}/relationship-list/relationship

see node definition for valid relationships
DELETE /common/policies/policy/{policy-id}/rules/rule/{rule-id}/selector-list/{selector}/relationship-list/relationship

delete an existing relationship
GET /common/policies/policy/{policy-id}/selector-list/{selector}

returns selector-list
PUT /common/policies/policy/{policy-id}/selector-list/{selector}

create or update an existing selector-list
PATCH /common/policies/policy/{policy-id}/selector-list/{selector}

update an existing selector-list
DELETE /common/policies/policy/{policy-id}/selector-list/{selector}

delete an existing selector-list
PUT /common/policies/policy/{policy-id}/selector-list/{selector}/relationship-list/relationship

see node definition for valid relationships
DELETE /common/policies/policy/{policy-id}/selector-list/{selector}/relationship-list/relationship

delete an existing relationship
GET /common/policy-key-terms

returns policy-key-terms
GET /common/policy-key-terms/policy-key-term/{policy-key-term-id}

returns policy-key-term
PUT /common/policy-key-terms/policy-key-term/{policy-key-term-id}

create or update an existing policy-key-term
PATCH /common/policy-key-terms/policy-key-term/{policy-key-term-id}

update an existing policy-key-term
DELETE /common/policy-key-terms/policy-key-term/{policy-key-term-id}

delete an existing policy-key-term
PUT /common/policy-key-terms/policy-key-term/{policy-key-term-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /common/policy-key-terms/policy-key-term/{policy-key-term-id}/relationship-list/relationship

delete an existing relationship
GET /common/policy-map-members

returns policy-map-members
GET /common/policy-map-members/policy-map-member/{policy-map-member-id}

returns policy-map-member
PUT /common/policy-map-members/policy-map-member/{policy-map-member-id}

create or update an existing policy-map-member
PATCH /common/policy-map-members/policy-map-member/{policy-map-member-id}

update an existing policy-map-member
DELETE /common/policy-map-members/policy-map-member/{policy-map-member-id}

delete an existing policy-map-member
PUT /common/policy-map-members/policy-map-member/{policy-map-member-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /common/policy-map-members/policy-map-member/{policy-map-member-id}/relationship-list/relationship

delete an existing relationship
GET /common/profiles

returns profiles
GET /common/profiles/profile/{profile-name}

returns profile
PUT /common/profiles/profile/{profile-name}

create or update an existing profile
PATCH /common/profiles/profile/{profile-name}

update an existing profile
DELETE /common/profiles/profile/{profile-name}

delete an existing profile
GET /common/profiles/profile/{profile-name}/metadata

returns metadata
GET /common/profiles/profile/{profile-name}/metadata/metadatum/{metaname}

returns metadatum
PUT /common/profiles/profile/{profile-name}/metadata/metadatum/{metaname}

create or update an existing metadatum
PATCH /common/profiles/profile/{profile-name}/metadata/metadatum/{metaname}

update an existing metadatum
DELETE /common/profiles/profile/{profile-name}/metadata/metadatum/{metaname}

delete an existing metadatum
PUT /common/profiles/profile/{profile-name}/relationship-list/relationship

see node definition for valid relationships
DELETE /common/profiles/profile/{profile-name}/relationship-list/relationship

delete an existing relationship
GET /common/relationship-rules

returns relationship-rules
GET /common/relationship-rules/relationship-rule/{rule-id}

returns relationship-rule
PUT /common/relationship-rules/relationship-rule/{rule-id}

create or update an existing relationship-rule
PATCH /common/relationship-rules/relationship-rule/{rule-id}

update an existing relationship-rule
DELETE /common/relationship-rules/relationship-rule/{rule-id}

delete an existing relationship-rule
GET /common/relationship-rules/relationship-rule/{rule-id}/relationship-components

returns relationship-components
GET /common/relationship-rules/relationship-rule/{rule-id}/relationship-components/relationship-component/{rule-node}

returns relationship-component
PUT /common/relationship-rules/relationship-rule/{rule-id}/relationship-components/relationship-component/{rule-node}

create or update an existing relationship-component
PATCH /common/relationship-rules/relationship-rule/{rule-id}/relationship-components/relationship-component/{rule-node}

update an existing relationship-component
DELETE /common/relationship-rules/relationship-rule/{rule-id}/relationship-components/relationship-component/{rule-node}

delete an existing relationship-component
PUT /common/relationship-rules/relationship-rule/{rule-id}/relationship-components/relationship-component/{rule-node}/relationship-list/relationship

see node definition for valid relationships
DELETE /common/relationship-rules/relationship-rule/{rule-id}/relationship-components/relationship-component/{rule-node}/relationship-list/relationship

delete an existing relationship
PUT /common/relationship-rules/relationship-rule/{rule-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /common/relationship-rules/relationship-rule/{rule-id}/relationship-list/relationship

delete an existing relationship
GET /common/vlan-characteristics

returns vlan-characteristics
GET /common/vlan-characteristics/vlan-characteristic/{vlan-characteristic-id}

returns vlan-characteristic
PUT /common/vlan-characteristics/vlan-characteristic/{vlan-characteristic-id}

create or update an existing vlan-characteristic
PATCH /common/vlan-characteristics/vlan-characteristic/{vlan-characteristic-id}

update an existing vlan-characteristic
DELETE /common/vlan-characteristics/vlan-characteristic/{vlan-characteristic-id}

delete an existing vlan-characteristic
PUT /common/vlan-characteristics/vlan-characteristic/{vlan-characteristic-id}/relationship-list/relationship

see node definition for valid relationships
DELETE /common/vlan-characteristics/vlan-characteristic/{vlan-characteristic-id}/relationship-list/relationship

delete an existing relationship

Paths

returns connectors

GET /business/connectors

Tags: Business

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/connectors
default

Response codes found in response codes.

returns connector

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

Tags: Business

returns connector
resource-instance-id

Unique id of resource instance.

 path string

application/json application/xml

200 OK

successful operation

/connector
default

Response codes found in response codes.

create or update an existing connector

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

Tags: Business

create or update an existing connector

application/json application/xml

connector object that needs to be created or updated.

/connector
resource-instance-id

Unique id of resource instance.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing connector

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

Tags: Business

update an existing connector

application/json application/xml

connector object that needs to be updated.

/zzzz-patch-connector
resource-instance-id

Unique id of resource instance.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing connector

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

Tags: Business

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

default

Response codes found in response codes.

returns metadata

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

Tags: Business

returns metadata
resource-instance-id

Unique id of resource instance.

 path string
metaname

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

200 OK

successful operation

/metadata
default

Response codes found in response codes.

returns metadatum

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

Tags: Business

returns metadatum
resource-instance-id

Unique id of resource instance.

 path string
metaname path string

application/json application/xml

200 OK

successful operation

/metadatum
default

Response codes found in response codes.

create or update an existing metadatum

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

Tags: Business

create or update an existing metadatum

application/json application/xml

metadatum object that needs to be created or updated.

/metadatum
resource-instance-id

Unique id of resource instance.

 path string
metaname path string

application/json application/xml

default

Response codes found in response codes.

update an existing metadatum

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

Tags: Business

update an existing metadatum

application/json application/xml

metadatum object that needs to be updated.

/zzzz-patch-metadatum
resource-instance-id

Unique id of resource instance.

 path string
metaname path string

application/json application/xml

default

Response codes found in response codes.

delete an existing metadatum

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

Tags: Business

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: Business

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
resource-instance-id

Unique id of resource instance.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

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

Tags: Business

delete an existing relationship

application/json application/xml

resource-instance-id

Unique id of resource instance.

 path string

application/json application/xml

default

Response codes found in response codes.

returns customers

GET /business/customers

Tags: Business

returns customers
global-customer-id

n/a

 query string
subscriber-name

n/a

 query string
subscriber-type

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

200 OK

successful operation

/customers
default

Response codes found in response codes.

returns customer

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

Tags: Business

returns customer
global-customer-id

Global customer id used across ONAP to uniquely identify customer.

 path string

application/json application/xml

200 OK

successful operation

/customer
default

Response codes found in response codes.

create or update an existing customer

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

Tags: Business

create or update an existing customer

application/json application/xml

customer object that needs to be created or updated.

/customer
global-customer-id

Global customer id used across ONAP to uniquely identify customer.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing customer

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

Tags: Business

update an existing customer

application/json application/xml

customer object that needs to be updated.

/zzzz-patch-customer
global-customer-id

Global customer id used across ONAP to uniquely identify customer.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing customer

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

Tags: Business

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: Business

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
global-customer-id

Global customer id used across ONAP to uniquely identify customer.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

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

Tags: Business

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

default

Response codes found in response codes.

returns service-subscriptions

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

Tags: Business

returns service-subscriptions
global-customer-id

Global customer id used across ONAP to uniquely identify customer.

 path string
service-type

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

200 OK

successful operation

/service-subscriptions
default

Response codes found in response codes.

returns service-subscription

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

Tags: Business

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

200 OK

successful operation

/service-subscription
default

Response codes found in response codes.

create or update an existing service-subscription

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

Tags: Business

create or update an existing service-subscription

application/json application/xml

service-subscription object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing service-subscription

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

Tags: Business

update an existing service-subscription

application/json application/xml

service-subscription object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing service-subscription

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

Tags: Business

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: Business

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: Business

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

default

Response codes found in response codes.

returns service-instances

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

Tags: Business

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/service-instances
default

Response codes found in response codes.

returns service-instance

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

Tags: Business

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

200 OK

successful operation

/service-instance
default

Response codes found in response codes.

create or update an existing service-instance

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

Tags: Business

create or update an existing service-instance

application/json application/xml

service-instance object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing service-instance

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

Tags: Business

update an existing service-instance

application/json application/xml

service-instance object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing service-instance

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

Tags: Business

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

default

Response codes found in response codes.

returns allotted-resources

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

Tags: Business

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/allotted-resources
default

Response codes found in response codes.

returns allotted-resource

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

Tags: Business

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

200 OK

successful operation

/allotted-resource
default

Response codes found in response codes.

create or update an existing allotted-resource

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

Tags: Business

create or update an existing allotted-resource

application/json application/xml

allotted-resource object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing allotted-resource

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

Tags: Business

update an existing allotted-resource

application/json application/xml

allotted-resource object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing allotted-resource

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

Tags: Business

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: Business

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: Business

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

default

Response codes found in response codes.

returns tunnel-xconnects

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

Tags: Business

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/tunnel-xconnects
default

Response codes found in response codes.

returns tunnel-xconnect

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

Tags: Business

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

200 OK

successful operation

/tunnel-xconnect
default

Response codes found in response codes.

create or update an existing tunnel-xconnect

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

Tags: Business

create or update an existing tunnel-xconnect

application/json application/xml

tunnel-xconnect object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing tunnel-xconnect

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

Tags: Business

update an existing tunnel-xconnect

application/json application/xml

tunnel-xconnect object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing tunnel-xconnect

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

Tags: Business

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: Business

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: Business

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

default

Response codes found in response codes.

returns communication-service-profiles

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

Tags: Business

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/communication-service-profiles
default

Response codes found in response codes.

returns communication-service-profile

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

Tags: Business

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

200 OK

successful operation

/communication-service-profile
default

Response codes found in response codes.

create or update an existing communication-service-profile

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

Tags: Business

create or update an existing communication-service-profile

application/json application/xml

communication-service-profile object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing communication-service-profile

PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/communication-service-profiles/communication-service-profile/{profile-id}

Tags: Business

update an existing communication-service-profile

application/json application/xml

communication-service-profile object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing communication-service-profile

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

Tags: Business

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: Business

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: Business

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

default

Response codes found in response codes.

returns composed-resources

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

Tags: Business

returns composed-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
orchestration-status

n/a

 query string
type

n/a

 query string
role

n/a

 query string
composed-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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/composed-resources
default

Response codes found in response codes.

returns composed-resource

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

Tags: Business

returns composed-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

Composed Resource id UUID assigned to this instance.

 path string

application/json application/xml

200 OK

successful operation

/composed-resource
default

Response codes found in response codes.

create or update an existing composed-resource

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

Tags: Business

create or update an existing composed-resource

application/json application/xml

composed-resource object that needs to be created or updated.

/composed-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

Composed Resource id UUID assigned to this instance.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing composed-resource

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

Tags: Business

update an existing composed-resource

application/json application/xml

composed-resource object that needs to be updated.

/zzzz-patch-composed-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

Composed Resource id UUID assigned to this instance.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing composed-resource

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

Tags: Business

delete an existing composed-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

Composed Resource id UUID assigned to this instance.

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: Business

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

Composed Resource id UUID assigned to this instance.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

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

Tags: Business

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

Composed Resource id UUID assigned to this instance.

 path string

application/json application/xml

default

Response codes found in response codes.

returns metadata

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

Tags: Business

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/metadata
default

Response codes found in response codes.

returns metadatum

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

Tags: Business

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

200 OK

successful operation

/metadatum
default

Response codes found in response codes.

create or update an existing metadatum

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

Tags: Business

create or update an existing metadatum

application/json application/xml

metadatum object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing metadatum

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

Tags: Business

update an existing metadatum

application/json application/xml

metadatum object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing metadatum

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

Tags: Business

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: Business

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: Business

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

default

Response codes found in response codes.

returns service-profiles

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

Tags: Business

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/service-profiles
default

Response codes found in response codes.

returns service-profile

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

Tags: Business

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

200 OK

successful operation

/service-profile
default

Response codes found in response codes.

create or update an existing service-profile

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

Tags: Business

create or update an existing service-profile

application/json application/xml

service-profile object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing service-profile

PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/service-profiles/service-profile/{profile-id}

Tags: Business

update an existing service-profile

application/json application/xml

service-profile object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing service-profile

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

Tags: Business

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: Business

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: Business

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

default

Response codes found in response codes.

returns slice-profiles

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

Tags: Business

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/slice-profiles
default

Response codes found in response codes.

returns slice-profile

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

Tags: Business

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

200 OK

successful operation

/slice-profile
default

Response codes found in response codes.

create or update an existing slice-profile

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

Tags: Business

create or update an existing slice-profile

application/json application/xml

slice-profile object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing slice-profile

PATCH /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/slice-profiles/slice-profile/{profile-id}

Tags: Business

update an existing slice-profile

application/json application/xml

slice-profile object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing slice-profile

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

Tags: Business

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: Business

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: Business

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

default

Response codes found in response codes.

returns lines-of-business

GET /business/lines-of-business

Tags: Business

returns lines-of-business
line-of-business-name

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

200 OK

successful operation

/lines-of-business
default

Response codes found in response codes.

returns line-of-business

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

Tags: Business

returns line-of-business
line-of-business-name

Name of the line-of-business (product)

 path string

application/json application/xml

200 OK

successful operation

/line-of-business
default

Response codes found in response codes.

create or update an existing line-of-business

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

Tags: Business

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
line-of-business-name

Name of the line-of-business (product)

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing line-of-business

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

Tags: Business

update an existing line-of-business

application/json application/xml

line-of-business object that needs to be updated.

/zzzz-patch-line-of-business
line-of-business-name

Name of the line-of-business (product)

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing line-of-business

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

Tags: Business

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: Business

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
line-of-business-name

Name of the line-of-business (product)

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

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

Tags: Business

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

default

Response codes found in response codes.

returns owning-entities

GET /business/owning-entities

Tags: Business

returns owning-entities
owning-entity-id

n/a

 query string
owning-entity-name

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

200 OK

successful operation

/owning-entities
default

Response codes found in response codes.

returns owning-entity

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

Tags: Business

returns owning-entity
owning-entity-id

UUID of an owning entity

 path string

application/json application/xml

200 OK

successful operation

/owning-entity
default

Response codes found in response codes.

create or update an existing owning-entity

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

Tags: Business

create or update an existing owning-entity

application/json application/xml

owning-entity object that needs to be created or updated.

/owning-entity
owning-entity-id

UUID of an owning entity

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing owning-entity

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

Tags: Business

update an existing owning-entity

application/json application/xml

owning-entity object that needs to be updated.

/zzzz-patch-owning-entity
owning-entity-id

UUID of an owning entity

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing owning-entity

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

Tags: Business

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: Business

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
owning-entity-id

UUID of an owning entity

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

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

Tags: Business

delete an existing relationship

application/json application/xml

owning-entity-id

UUID of an owning entity

 path string

application/json application/xml

default

Response codes found in response codes.

returns platforms

GET /business/platforms

Tags: Business

returns platforms
platform-name

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

200 OK

successful operation

/platforms
default

Response codes found in response codes.

returns platform

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

Tags: Business

returns platform
platform-name

Name of the platform

 path string

application/json application/xml

200 OK

successful operation

/platform
default

Response codes found in response codes.

create or update an existing platform

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

Tags: Business

create or update an existing platform

application/json application/xml

platform object that needs to be created or updated.

/platform
platform-name

Name of the platform

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing platform

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

Tags: Business

update an existing platform

application/json application/xml

platform object that needs to be updated.

/zzzz-patch-platform
platform-name

Name of the platform

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing platform

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

Tags: Business

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: Business

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
platform-name

Name of the platform

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

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

Tags: Business

delete an existing relationship

application/json application/xml

platform-name

Name of the platform

 path string

application/json application/xml

default

Response codes found in response codes.

returns projects

GET /business/projects

Tags: Business

returns projects
project-name

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

200 OK

successful operation

/projects
default

Response codes found in response codes.

returns project

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

Tags: Business

returns project
project-name

Name of the project deploying a service

 path string

application/json application/xml

200 OK

successful operation

/project
default

Response codes found in response codes.

create or update an existing project

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

Tags: Business

create or update an existing project

application/json application/xml

project object that needs to be created or updated.

/project
project-name

Name of the project deploying a service

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing project

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

Tags: Business

update an existing project

application/json application/xml

project object that needs to be updated.

/zzzz-patch-project
project-name

Name of the project deploying a service

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing project

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

Tags: Business

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: Business

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
project-name

Name of the project deploying a service

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

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

Tags: Business

delete an existing relationship

application/json application/xml

project-name

Name of the project deploying a service

 path string

application/json application/xml

default

Response codes found in response codes.

returns sp-partners

GET /business/sp-partners

Tags: Business

returns sp-partners
sp-partner-id

n/a

 query string
url

n/a

 query string
callsource

n/a

 query string
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string
model-invariant-id

n/a

 query string
model-version-id

n/a

 query string

application/json application/xml

200 OK

successful operation

/sp-partners
default

Response codes found in response codes.

returns sp-partner

GET /business/sp-partners/sp-partner/{sp-partner-id}

Tags: Business

returns sp-partner
sp-partner-id

Uniquely identifies this sp-partner by id

 path string

application/json application/xml

200 OK

successful operation

/sp-partner
default

Response codes found in response codes.

create or update an existing sp-partner

PUT /business/sp-partners/sp-partner/{sp-partner-id}

Tags: Business

create or update an existing sp-partner

application/json application/xml

sp-partner object that needs to be created or updated.

/sp-partner
sp-partner-id

Uniquely identifies this sp-partner by id

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing sp-partner

PATCH /business/sp-partners/sp-partner/{sp-partner-id}

Tags: Business

update an existing sp-partner

application/json application/xml

sp-partner object that needs to be updated.

/zzzz-patch-sp-partner
sp-partner-id

Uniquely identifies this sp-partner by id

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing sp-partner

DELETE /business/sp-partners/sp-partner/{sp-partner-id}

Tags: Business

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /business/sp-partners/sp-partner/{sp-partner-id}/relationship-list/relationship

Tags: Business

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
sp-partner-id

Uniquely identifies this sp-partner by id

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /business/sp-partners/sp-partner/{sp-partner-id}/relationship-list/relationship

Tags: Business

delete an existing relationship

application/json application/xml

sp-partner-id

Uniquely identifies this sp-partner by id

 path string

application/json application/xml

default

Response codes found in response codes.

returns cloud-regions

GET /cloud-infrastructure/cloud-regions

Tags: CloudInfrastructure

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
identity-url

n/a

 query string
complex-name

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

200 OK

successful operation

/cloud-regions
default

Response codes found in response codes.

returns cloud-region

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

Tags: CloudInfrastructure

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

200 OK

successful operation

/cloud-region
default

Response codes found in response codes.

create or update an existing cloud-region

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

Tags: CloudInfrastructure

create or update an existing cloud-region

application/json application/xml

cloud-region object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing cloud-region

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

Tags: CloudInfrastructure

update an existing cloud-region

application/json application/xml

cloud-region object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing cloud-region

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns activities

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

Tags: CloudInfrastructure

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

200 OK

successful operation

/activities
default

Response codes found in response codes.

returns activity

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

Tags: CloudInfrastructure

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

200 OK

successful operation

/activity
default

Response codes found in response codes.

create or update an existing activity

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

Tags: CloudInfrastructure

create or update an existing activity

application/json application/xml

activity object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing activity

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/activities/activity/{activity-id}

Tags: CloudInfrastructure

update an existing activity

application/json application/xml

activity object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing activity

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns activity-states

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/activities/activity/{activity-id}/activity-states

Tags: CloudInfrastructure

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

200 OK

successful operation

/activity-states
default

Response codes found in response codes.

returns activity-state

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

Tags: CloudInfrastructure

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

200 OK

successful operation

/activity-state
default

Response codes found in response codes.

create or update an existing activity-state

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

Tags: CloudInfrastructure

create or update an existing activity-state

application/json application/xml

activity-state object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing activity-state

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

Tags: CloudInfrastructure

update an existing activity-state

application/json application/xml

activity-state object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing activity-state

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}/relationship-list/relationship

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns availability-zones

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

Tags: CloudInfrastructure

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/availability-zones
default

Response codes found in response codes.

returns availability-zone

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

Tags: CloudInfrastructure

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

200 OK

successful operation

/availability-zone
default

Response codes found in response codes.

create or update an existing availability-zone

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

Tags: CloudInfrastructure

create or update an existing availability-zone

application/json application/xml

availability-zone object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing availability-zone

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

Tags: CloudInfrastructure

update an existing availability-zone

application/json application/xml

availability-zone object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing availability-zone

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns dvs-switches

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

Tags: CloudInfrastructure

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/dvs-switches
default

Response codes found in response codes.

returns dvs-switch

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

Tags: CloudInfrastructure

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

200 OK

successful operation

/dvs-switch
default

Response codes found in response codes.

create or update an existing dvs-switch

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

Tags: CloudInfrastructure

create or update an existing dvs-switch

application/json application/xml

dvs-switch object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing dvs-switch

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

Tags: CloudInfrastructure

update an existing dvs-switch

application/json application/xml

dvs-switch object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing dvs-switch

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns esr-system-info-list

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

Tags: CloudInfrastructure

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/esr-system-info-list
default

Response codes found in response codes.

returns esr-system-info

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

Tags: CloudInfrastructure

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

200 OK

successful operation

/esr-system-info
default

Response codes found in response codes.

create or update an existing esr-system-info

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

Tags: CloudInfrastructure

create or update an existing esr-system-info

application/json application/xml

esr-system-info object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing esr-system-info

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

Tags: CloudInfrastructure

update an existing esr-system-info

application/json application/xml

esr-system-info object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing esr-system-info

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns flavors

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

Tags: CloudInfrastructure

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/flavors
default

Response codes found in response codes.

returns flavor

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

Tags: CloudInfrastructure

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

200 OK

successful operation

/flavor
default

Response codes found in response codes.

create or update an existing flavor

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

Tags: CloudInfrastructure

create or update an existing flavor

application/json application/xml

flavor object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing flavor

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

Tags: CloudInfrastructure

update an existing flavor

application/json application/xml

flavor object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing flavor

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns hpa-capabilities

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities

Tags: CloudInfrastructure

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/hpa-capabilities
default

Response codes found in response codes.

returns hpa-capability

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

Tags: CloudInfrastructure

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

200 OK

successful operation

/hpa-capability
default

Response codes found in response codes.

create or update an existing hpa-capability

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

Tags: CloudInfrastructure

create or update an existing hpa-capability

application/json application/xml

hpa-capability object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing hpa-capability

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

Tags: CloudInfrastructure

update an existing hpa-capability

application/json application/xml

hpa-capability object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing hpa-capability

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns hpa-feature-attributes

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}

Tags: CloudInfrastructure

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

200 OK

successful operation

/hpa-feature-attributes
default

Response codes found in response codes.

create or update an existing hpa-feature-attributes

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}

Tags: CloudInfrastructure

create or update an existing hpa-feature-attributes

application/json application/xml

hpa-feature-attributes object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing hpa-feature-attributes

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}

Tags: CloudInfrastructure

update an existing hpa-feature-attributes

application/json application/xml

hpa-feature-attributes object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing hpa-feature-attributes

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}/relationship-list/relationship

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns group-assignments

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

Tags: CloudInfrastructure

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/group-assignments
default

Response codes found in response codes.

returns group-assignment

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

Tags: CloudInfrastructure

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

200 OK

successful operation

/group-assignment
default

Response codes found in response codes.

create or update an existing group-assignment

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

Tags: CloudInfrastructure

create or update an existing group-assignment

application/json application/xml

group-assignment object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing group-assignment

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

Tags: CloudInfrastructure

update an existing group-assignment

application/json application/xml

group-assignment object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing group-assignment

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns host-aggregates

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

Tags: CloudInfrastructure

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

200 OK

successful operation

/host-aggregates
default

Response codes found in response codes.

returns host-aggregate

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/host-aggregates/host-aggregate/{host-aggregate-id}

Tags: CloudInfrastructure

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

200 OK

successful operation

/host-aggregate
default

Response codes found in response codes.

create or update an existing host-aggregate

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/host-aggregates/host-aggregate/{host-aggregate-id}

Tags: CloudInfrastructure

create or update an existing host-aggregate

application/json application/xml

host-aggregate object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing host-aggregate

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/host-aggregates/host-aggregate/{host-aggregate-id}

Tags: CloudInfrastructure

update an existing host-aggregate

application/json application/xml

host-aggregate object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing host-aggregate

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/host-aggregates/host-aggregate/{host-aggregate-id}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns hpa-capabilities

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

Tags: CloudInfrastructure

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/hpa-capabilities
default

Response codes found in response codes.

returns hpa-capability

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

Tags: CloudInfrastructure

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

200 OK

successful operation

/hpa-capability
default

Response codes found in response codes.

create or update an existing hpa-capability

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

Tags: CloudInfrastructure

create or update an existing hpa-capability

application/json application/xml

hpa-capability object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing hpa-capability

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

Tags: CloudInfrastructure

update an existing hpa-capability

application/json application/xml

hpa-capability object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing hpa-capability

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns hpa-feature-attributes

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}

Tags: CloudInfrastructure

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

200 OK

successful operation

/hpa-feature-attributes
default

Response codes found in response codes.

create or update an existing hpa-feature-attributes

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}

Tags: CloudInfrastructure

create or update an existing hpa-feature-attributes

application/json application/xml

hpa-feature-attributes object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing hpa-feature-attributes

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}

Tags: CloudInfrastructure

update an existing hpa-feature-attributes

application/json application/xml

hpa-feature-attributes object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing hpa-feature-attributes

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}/relationship-list/relationship

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns images

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

Tags: CloudInfrastructure

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/images
default

Response codes found in response codes.

returns image

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

Tags: CloudInfrastructure

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

200 OK

successful operation

/image
default

Response codes found in response codes.

create or update an existing image

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

Tags: CloudInfrastructure

create or update an existing image

application/json application/xml

image object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing image

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

Tags: CloudInfrastructure

update an existing image

application/json application/xml

image object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing image

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns metadata

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

Tags: CloudInfrastructure

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/metadata
default

Response codes found in response codes.

returns metadatum

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

Tags: CloudInfrastructure

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

200 OK

successful operation

/metadatum
default

Response codes found in response codes.

create or update an existing metadatum

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

Tags: CloudInfrastructure

create or update an existing metadatum

application/json application/xml

metadatum object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing metadatum

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

Tags: CloudInfrastructure

update an existing metadatum

application/json application/xml

metadatum object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing metadatum

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns oam-networks

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

Tags: CloudInfrastructure

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/oam-networks
default

Response codes found in response codes.

returns oam-network

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

Tags: CloudInfrastructure

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

200 OK

successful operation

/oam-network
default

Response codes found in response codes.

create or update an existing oam-network

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

Tags: CloudInfrastructure

create or update an existing oam-network

application/json application/xml

oam-network object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing oam-network

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

Tags: CloudInfrastructure

update an existing oam-network

application/json application/xml

oam-network object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing oam-network

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns snapshots

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

Tags: CloudInfrastructure

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/snapshots
default

Response codes found in response codes.

returns snapshot

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

Tags: CloudInfrastructure

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

200 OK

successful operation

/snapshot
default

Response codes found in response codes.

create or update an existing snapshot

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

Tags: CloudInfrastructure

create or update an existing snapshot

application/json application/xml

snapshot object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing snapshot

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

Tags: CloudInfrastructure

update an existing snapshot

application/json application/xml

snapshot object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing snapshot

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns tenants

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

Tags: CloudInfrastructure

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/tenants
default

Response codes found in response codes.

returns tenant

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

Tags: CloudInfrastructure

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

200 OK

successful operation

/tenant
default

Response codes found in response codes.

create or update an existing tenant

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

Tags: CloudInfrastructure

create or update an existing tenant

application/json application/xml

tenant object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing tenant

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

Tags: CloudInfrastructure

update an existing tenant

application/json application/xml

tenant object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing tenant

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns k8s-resources

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/k8s-resources

Tags: CloudInfrastructure

returns k8s-resources
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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
id

n/a

 query string
name

n/a

 query string
group

n/a

 query string
version

n/a

 query string
kind

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

200 OK

successful operation

/k8s-resources
default

Response codes found in response codes.

returns k8s-resource

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/k8s-resources/k8s-resource/{id}

Tags: CloudInfrastructure

returns k8s-resource
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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
id

Unique id of k8s resource. This is unique across the graph.

 path string

application/json application/xml

200 OK

successful operation

/k8s-resource
default

Response codes found in response codes.

create or update an existing k8s-resource

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

Tags: CloudInfrastructure

create or update an existing k8s-resource

application/json application/xml

k8s-resource object that needs to be created or updated.

/k8s-resource
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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
id

Unique id of k8s resource. This is unique across the graph.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing k8s-resource

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/k8s-resources/k8s-resource/{id}

Tags: CloudInfrastructure

update an existing k8s-resource

application/json application/xml

k8s-resource object that needs to be updated.

/zzzz-patch-k8s-resource
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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
id

Unique id of k8s resource. This is unique across the graph.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing k8s-resource

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

Tags: CloudInfrastructure

delete an existing k8s-resource

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
id

Unique id of k8s resource. This is unique across the graph.

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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
id

Unique id of k8s resource. This is unique across the graph.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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
id

Unique id of k8s resource. This is unique across the graph.

 path string

application/json application/xml

default

Response codes found in response codes.

returns nos-servers

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/nos-servers

Tags: CloudInfrastructure

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/nos-servers
default

Response codes found in response codes.

returns nos-server

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/nos-servers/nos-server/{nos-server-id}

Tags: CloudInfrastructure

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

200 OK

successful operation

/nos-server
default

Response codes found in response codes.

create or update an existing nos-server

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

Tags: CloudInfrastructure

create or update an existing nos-server

application/json application/xml

nos-server object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing nos-server

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/nos-servers/nos-server/{nos-server-id}

Tags: CloudInfrastructure

update an existing nos-server

application/json application/xml

nos-server object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing nos-server

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns vservers

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

Tags: CloudInfrastructure

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/vservers
default

Response codes found in response codes.

returns vserver

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

Tags: CloudInfrastructure

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

200 OK

successful operation

/vserver
default

Response codes found in response codes.

create or update an existing vserver

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

Tags: CloudInfrastructure

create or update an existing vserver

application/json application/xml

vserver object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing vserver

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

Tags: CloudInfrastructure

update an existing vserver

application/json application/xml

vserver object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing vserver

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns l-interfaces

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces

Tags: CloudInfrastructure

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/l-interfaces
default

Response codes found in response codes.

returns l-interface

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}

Tags: CloudInfrastructure

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

200 OK

successful operation

/l-interface
default

Response codes found in response codes.

create or update an existing l-interface

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}

Tags: CloudInfrastructure

create or update an existing l-interface

application/json application/xml

l-interface object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing l-interface

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}

Tags: CloudInfrastructure

update an existing l-interface

application/json application/xml

l-interface object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l-interface

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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

200 OK

successful operation

/l3-interface-ipv4-address-list
default

Response codes found in response codes.

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

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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.

/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

default

Response codes found in response codes.

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

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

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

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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

200 OK

successful operation

/l3-interface-ipv6-address-list
default

Response codes found in response codes.

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

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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.

/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

default

Response codes found in response codes.

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

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

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

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns lcmp-unreachables

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables

Tags: CloudInfrastructure

returns lcmp-unreachables
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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
lcmp-unreachable-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

200 OK

successful operation

/lcmp-unreachables
default

Response codes found in response codes.

returns lcmp-unreachable

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: CloudInfrastructure

returns lcmp-unreachable
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

200 OK

successful operation

/lcmp-unreachable
default

Response codes found in response codes.

create or update an existing lcmp-unreachable

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: CloudInfrastructure

create or update an existing lcmp-unreachable

application/json application/xml

lcmp-unreachable object that needs to be created or updated.

/lcmp-unreachable
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing lcmp-unreachable

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: CloudInfrastructure

update an existing lcmp-unreachable

application/json application/xml

lcmp-unreachable object that needs to be updated.

/zzzz-patch-lcmp-unreachable
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing lcmp-unreachable

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: CloudInfrastructure

delete an existing lcmp-unreachable

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
lcmp-unreachable-id

object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

Tags: CloudInfrastructure

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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns sriov-vfs

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs

Tags: CloudInfrastructure

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string
neutron-network-id

n/a

 query string

application/json application/xml

200 OK

successful operation

/sriov-vfs
default

Response codes found in response codes.

returns sriov-vf

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: CloudInfrastructure

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

200 OK

successful operation

/sriov-vf
default

Response codes found in response codes.

create or update an existing sriov-vf

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: CloudInfrastructure

create or update an existing sriov-vf

application/json application/xml

sriov-vf object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing sriov-vf

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: CloudInfrastructure

update an existing sriov-vf

application/json application/xml

sriov-vf object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing sriov-vf

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns temporary-parameter-lists

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists

Tags: CloudInfrastructure

returns temporary-parameter-lists
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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
temporary-parameter-list-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

200 OK

successful operation

/temporary-parameter-lists
default

Response codes found in response codes.

returns temporary-parameter-list

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: CloudInfrastructure

returns temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

200 OK

successful operation

/temporary-parameter-list
default

Response codes found in response codes.

create or update an existing temporary-parameter-list

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: CloudInfrastructure

create or update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be created or updated.

/temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing temporary-parameter-list

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: CloudInfrastructure

update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be updated.

/zzzz-patch-temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing temporary-parameter-list

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: CloudInfrastructure

delete an existing temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: CloudInfrastructure

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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

returns vlans

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans

Tags: CloudInfrastructure

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
vlan-id-outer

n/a

 query integer
vlan-type

n/a

 query string
vpn-key

n/a

 query string
orchestration-status

n/a

 query string
prov-status

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

200 OK

successful operation

/vlans
default

Response codes found in response codes.

returns vlan

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: CloudInfrastructure

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

200 OK

successful operation

/vlan
default

Response codes found in response codes.

create or update an existing vlan

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: CloudInfrastructure

create or update an existing vlan

application/json application/xml

vlan object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing vlan

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: CloudInfrastructure

update an existing vlan

application/json application/xml

vlan object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing vlan

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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

200 OK

successful operation

/l3-interface-ipv4-address-list
default

Response codes found in response codes.

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

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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.

/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

default

Response codes found in response codes.

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

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

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

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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

200 OK

successful operation

/l3-interface-ipv6-address-list
default

Response codes found in response codes.

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

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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.

/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

default

Response codes found in response codes.

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

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

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

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns volumes

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

Tags: CloudInfrastructure

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/volumes
default

Response codes found in response codes.

returns volume

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

Tags: CloudInfrastructure

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

200 OK

successful operation

/volume
default

Response codes found in response codes.

create or update an existing volume

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

Tags: CloudInfrastructure

create or update an existing volume

application/json application/xml

volume object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing volume

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

Tags: CloudInfrastructure

update an existing volume

application/json application/xml

volume object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing volume

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns validation-audits

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

Tags: CloudInfrastructure

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/validation-audits
default

Response codes found in response codes.

returns validation-audit

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/validation-audits/validation-audit/{validation-id}

Tags: CloudInfrastructure

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

200 OK

successful operation

/validation-audit
default

Response codes found in response codes.

create or update an existing validation-audit

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/validation-audits/validation-audit/{validation-id}

Tags: CloudInfrastructure

create or update an existing validation-audit

application/json application/xml

validation-audit object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing validation-audit

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/validation-audits/validation-audit/{validation-id}

Tags: CloudInfrastructure

update an existing validation-audit

application/json application/xml

validation-audit object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing validation-audit

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/validation-audits/validation-audit/{validation-id}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns vip-ipv4-address-list

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

Tags: CloudInfrastructure

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

200 OK

successful operation

/vip-ipv4-address-list
default

Response codes found in response codes.

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

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

Tags: CloudInfrastructure

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.

/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

default

Response codes found in response codes.

update an existing vip-ipv4-address-list

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

Tags: CloudInfrastructure

update an existing vip-ipv4-address-list

application/json application/xml

vip-ipv4-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing vip-ipv4-address-list

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns vip-ipv6-address-list

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

Tags: CloudInfrastructure

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

200 OK

successful operation

/vip-ipv6-address-list
default

Response codes found in response codes.

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

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

Tags: CloudInfrastructure

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.

/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

default

Response codes found in response codes.

update an existing vip-ipv6-address-list

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

Tags: CloudInfrastructure

update an existing vip-ipv6-address-list

application/json application/xml

vip-ipv6-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing vip-ipv6-address-list

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns vlan-ranges

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

Tags: CloudInfrastructure

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/vlan-ranges
default

Response codes found in response codes.

returns vlan-range

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vlan-ranges/vlan-range/{vlan-range-id}

Tags: CloudInfrastructure

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

200 OK

successful operation

/vlan-range
default

Response codes found in response codes.

create or update an existing vlan-range

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vlan-ranges/vlan-range/{vlan-range-id}

Tags: CloudInfrastructure

create or update an existing vlan-range

application/json application/xml

vlan-range object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing vlan-range

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vlan-ranges/vlan-range/{vlan-range-id}

Tags: CloudInfrastructure

update an existing vlan-range

application/json application/xml

vlan-range object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing vlan-range

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vlan-ranges/vlan-range/{vlan-range-id}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns vlan-tags

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vlan-ranges/vlan-range/{vlan-range-id}/vlan-tags

Tags: CloudInfrastructure

returns vlan-tags
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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
vlan-id-inner

n/a

 query integer
vlan-id-outer

n/a

 query integer
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/vlan-tags
default

Response codes found in response codes.

returns vlan-tag

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vlan-ranges/vlan-range/{vlan-range-id}/vlan-tags/vlan-tag/{vlan-tag-id}

Tags: CloudInfrastructure

returns vlan-tag
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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
vlan-tag-id

Vlan Tag Id

 path string

application/json application/xml

200 OK

successful operation

/vlan-tag
default

Response codes found in response codes.

create or update an existing vlan-tag

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vlan-ranges/vlan-range/{vlan-range-id}/vlan-tags/vlan-tag/{vlan-tag-id}

Tags: CloudInfrastructure

create or update an existing vlan-tag

application/json application/xml

vlan-tag object that needs to be created or updated.

/vlan-tag
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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
vlan-tag-id

Vlan Tag Id

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing vlan-tag

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vlan-ranges/vlan-range/{vlan-range-id}/vlan-tags/vlan-tag/{vlan-tag-id}

Tags: CloudInfrastructure

update an existing vlan-tag

application/json application/xml

vlan-tag object that needs to be updated.

/zzzz-patch-vlan-tag
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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
vlan-tag-id

Vlan Tag Id

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing vlan-tag

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vlan-ranges/vlan-range/{vlan-range-id}/vlan-tags/vlan-tag/{vlan-tag-id}

Tags: CloudInfrastructure

delete an existing vlan-tag

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
vlan-tag-id

Vlan Tag Id

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vlan-ranges/vlan-range/{vlan-range-id}/vlan-tags/vlan-tag/{vlan-tag-id}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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
vlan-tag-id

Vlan Tag Id

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vlan-ranges/vlan-range/{vlan-range-id}/vlan-tags/vlan-tag/{vlan-tag-id}/relationship-list/relationship

Tags: CloudInfrastructure

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
vlan-tag-id

Vlan Tag Id

 path string

application/json application/xml

default

Response codes found in response codes.

returns volume-groups

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

Tags: CloudInfrastructure

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/volume-groups
default

Response codes found in response codes.

returns volume-group

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

Tags: CloudInfrastructure

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

200 OK

successful operation

/volume-group
default

Response codes found in response codes.

create or update an existing volume-group

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

Tags: CloudInfrastructure

create or update an existing volume-group

application/json application/xml

volume-group object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing volume-group

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

Tags: CloudInfrastructure

update an existing volume-group

application/json application/xml

volume-group object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing volume-group

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns complexes

GET /cloud-infrastructure/complexes

Tags: CloudInfrastructure

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/complexes
default

Response codes found in response codes.

returns complex

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

Tags: CloudInfrastructure

returns complex
physical-location-id

Unique identifier for physical location, e.g., CLLI

 path string

application/json application/xml

200 OK

successful operation

/complex
default

Response codes found in response codes.

create or update an existing complex

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

Tags: CloudInfrastructure

create or update an existing complex

application/json application/xml

complex object that needs to be created or updated.

/complex
physical-location-id

Unique identifier for physical location, e.g., CLLI

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing complex

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

Tags: CloudInfrastructure

update an existing complex

application/json application/xml

complex object that needs to be updated.

/zzzz-patch-complex
physical-location-id

Unique identifier for physical location, e.g., CLLI

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing complex

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns cables

GET /cloud-infrastructure/complexes/complex/{physical-location-id}/cables

Tags: CloudInfrastructure

returns cables
physical-location-id

Unique identifier for physical location, e.g., CLLI

 path string
cable-name

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

200 OK

successful operation

/cables
default

Response codes found in response codes.

returns cable

GET /cloud-infrastructure/complexes/complex/{physical-location-id}/cables/cable/{cable-name}

Tags: CloudInfrastructure

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

200 OK

successful operation

/cable
default

Response codes found in response codes.

create or update an existing cable

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

Tags: CloudInfrastructure

create or update an existing cable

application/json application/xml

cable object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing cable

PATCH /cloud-infrastructure/complexes/complex/{physical-location-id}/cables/cable/{cable-name}

Tags: CloudInfrastructure

update an existing cable

application/json application/xml

cable object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing cable

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns ctag-pools

GET /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools

Tags: CloudInfrastructure

returns ctag-pools
physical-location-id

Unique identifier for physical location, e.g., CLLI

 path string
availability-zone-name

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

200 OK

successful operation

/ctag-pools
default

Response codes found in response codes.

returns ctag-pool

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

Tags: CloudInfrastructure

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

200 OK

successful operation

/ctag-pool
default

Response codes found in response codes.

create or update an existing ctag-pool

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

Tags: CloudInfrastructure

create or update an existing ctag-pool

application/json application/xml

ctag-pool object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing ctag-pool

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

Tags: CloudInfrastructure

update an existing ctag-pool

application/json application/xml

ctag-pool object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing ctag-pool

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns racks

GET /cloud-infrastructure/complexes/complex/{physical-location-id}/racks

Tags: CloudInfrastructure

returns racks
physical-location-id

Unique identifier for physical location, e.g., CLLI

 path string
rack-name

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

200 OK

successful operation

/racks
default

Response codes found in response codes.

returns rack

GET /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}

Tags: CloudInfrastructure

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

200 OK

successful operation

/rack
default

Response codes found in response codes.

create or update an existing rack

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

Tags: CloudInfrastructure

create or update an existing rack

application/json application/xml

rack object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing rack

PATCH /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}

Tags: CloudInfrastructure

update an existing rack

application/json application/xml

rack object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing rack

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns pdus

GET /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}/pdus

Tags: CloudInfrastructure

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/pdus
default

Response codes found in response codes.

returns pdu

GET /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}/pdus/pdu/{pdu-name}

Tags: CloudInfrastructure

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

200 OK

successful operation

/pdu
default

Response codes found in response codes.

create or update an existing pdu

PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}/pdus/pdu/{pdu-name}

Tags: CloudInfrastructure

create or update an existing pdu

application/json application/xml

pdu object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing pdu

PATCH /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}/pdus/pdu/{pdu-name}

Tags: CloudInfrastructure

update an existing pdu

application/json application/xml

pdu object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing pdu

DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}/pdus/pdu/{pdu-name}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}/pdus/pdu/{pdu-name}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}/pdus/pdu/{pdu-name}/relationship-list/relationship

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns rack-units

GET /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}/rack-units

Tags: CloudInfrastructure

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/rack-units
default

Response codes found in response codes.

returns rack-unit

GET /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}/rack-units/rack-unit/{rack-unit-name}

Tags: CloudInfrastructure

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

200 OK

successful operation

/rack-unit
default

Response codes found in response codes.

create or update an existing rack-unit

PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}/rack-units/rack-unit/{rack-unit-name}

Tags: CloudInfrastructure

create or update an existing rack-unit

application/json application/xml

rack-unit object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing rack-unit

PATCH /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}/rack-units/rack-unit/{rack-unit-name}

Tags: CloudInfrastructure

update an existing rack-unit

application/json application/xml

rack-unit object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing rack-unit

DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}/rack-units/rack-unit/{rack-unit-name}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}/rack-units/rack-unit/{rack-unit-name}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}/racks/rack/{rack-name}/rack-units/rack-unit/{rack-unit-name}/relationship-list/relationship

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
physical-location-id

Unique identifier for physical location, e.g., CLLI

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns endpoints

GET /cloud-infrastructure/endpoints

Tags: CloudInfrastructure

returns endpoints
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/endpoints
default

Response codes found in response codes.

returns endpoint

GET /cloud-infrastructure/endpoints/endpoint/{endpoint-id}

Tags: CloudInfrastructure

returns endpoint
endpoint-id

Unique identifier for the endpoint.

 path string

application/json application/xml

200 OK

successful operation

/endpoint
default

Response codes found in response codes.

create or update an existing endpoint

PUT /cloud-infrastructure/endpoints/endpoint/{endpoint-id}

Tags: CloudInfrastructure

create or update an existing endpoint

application/json application/xml

endpoint object that needs to be created or updated.

/endpoint
endpoint-id

Unique identifier for the endpoint.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing endpoint

PATCH /cloud-infrastructure/endpoints/endpoint/{endpoint-id}

Tags: CloudInfrastructure

update an existing endpoint

application/json application/xml

endpoint object that needs to be updated.

/zzzz-patch-endpoint
endpoint-id

Unique identifier for the endpoint.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing endpoint

DELETE /cloud-infrastructure/endpoints/endpoint/{endpoint-id}

Tags: CloudInfrastructure

delete an existing endpoint

application/json application/xml

endpoint-id

Unique identifier for the endpoint.

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

returns ip-address-list

GET /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/ip-address-list/{ip-address}

Tags: CloudInfrastructure

returns ip-address-list
endpoint-id

Unique identifier for the endpoint.

 path string
ip-address

IP address

 path string

application/json application/xml

200 OK

successful operation

/ip-address-list
default

Response codes found in response codes.

create or update an existing ip-address-list

PUT /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/ip-address-list/{ip-address}

Tags: CloudInfrastructure

create or update an existing ip-address-list

application/json application/xml

ip-address-list object that needs to be created or updated.

/ip-address-list
endpoint-id

Unique identifier for the endpoint.

 path string
ip-address

IP address

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing ip-address-list

PATCH /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/ip-address-list/{ip-address}

Tags: CloudInfrastructure

update an existing ip-address-list

application/json application/xml

ip-address-list object that needs to be updated.

/zzzz-patch-ip-address-list
endpoint-id

Unique identifier for the endpoint.

 path string
ip-address

IP address

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing ip-address-list

DELETE /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/ip-address-list/{ip-address}

Tags: CloudInfrastructure

delete an existing ip-address-list

application/json application/xml

endpoint-id

Unique identifier for the endpoint.

 path string
ip-address

IP address

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/ip-address-list/{ip-address}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
endpoint-id

Unique identifier for the endpoint.

 path string
ip-address

IP address

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/ip-address-list/{ip-address}/relationship-list/relationship

Tags: CloudInfrastructure

delete an existing relationship

application/json application/xml

endpoint-id

Unique identifier for the endpoint.

 path string
ip-address

IP address

 path string

application/json application/xml

default

Response codes found in response codes.

returns port-list

GET /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/port-list/{port}

Tags: CloudInfrastructure

returns port-list
endpoint-id

Unique identifier for the endpoint.

 path string
port

Port number

 path string

application/json application/xml

200 OK

successful operation

/port-list
default

Response codes found in response codes.

create or update an existing port-list

PUT /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/port-list/{port}

Tags: CloudInfrastructure

create or update an existing port-list

application/json application/xml

port-list object that needs to be created or updated.

/port-list
endpoint-id

Unique identifier for the endpoint.

 path string
port

Port number

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing port-list

PATCH /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/port-list/{port}

Tags: CloudInfrastructure

update an existing port-list

application/json application/xml

port-list object that needs to be updated.

/zzzz-patch-port-list
endpoint-id

Unique identifier for the endpoint.

 path string
port

Port number

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing port-list

DELETE /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/port-list/{port}

Tags: CloudInfrastructure

delete an existing port-list

application/json application/xml

endpoint-id

Unique identifier for the endpoint.

 path string
port

Port number

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/port-list/{port}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
endpoint-id

Unique identifier for the endpoint.

 path string
port

Port number

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/port-list/{port}/relationship-list/relationship

Tags: CloudInfrastructure

delete an existing relationship

application/json application/xml

endpoint-id

Unique identifier for the endpoint.

 path string
port

Port number

 path string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
endpoint-id

Unique identifier for the endpoint.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/relationship-list/relationship

Tags: CloudInfrastructure

delete an existing relationship

application/json application/xml

endpoint-id

Unique identifier for the endpoint.

 path string

application/json application/xml

default

Response codes found in response codes.

returns selector-list

GET /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/selector-list/{selector}

Tags: CloudInfrastructure

returns selector-list
endpoint-id

Unique identifier for the endpoint.

 path string
selector

Selector

 path string

application/json application/xml

200 OK

successful operation

/selector-list
default

Response codes found in response codes.

create or update an existing selector-list

PUT /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/selector-list/{selector}

Tags: CloudInfrastructure

create or update an existing selector-list

application/json application/xml

selector-list object that needs to be created or updated.

/selector-list
endpoint-id

Unique identifier for the endpoint.

 path string
selector

Selector

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing selector-list

PATCH /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/selector-list/{selector}

Tags: CloudInfrastructure

update an existing selector-list

application/json application/xml

selector-list object that needs to be updated.

/zzzz-patch-selector-list
endpoint-id

Unique identifier for the endpoint.

 path string
selector

Selector

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing selector-list

DELETE /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/selector-list/{selector}

Tags: CloudInfrastructure

delete an existing selector-list

application/json application/xml

endpoint-id

Unique identifier for the endpoint.

 path string
selector

Selector

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/selector-list/{selector}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
endpoint-id

Unique identifier for the endpoint.

 path string
selector

Selector

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/endpoints/endpoint/{endpoint-id}/selector-list/{selector}/relationship-list/relationship

Tags: CloudInfrastructure

delete an existing relationship

application/json application/xml

endpoint-id

Unique identifier for the endpoint.

 path string
selector

Selector

 path string

application/json application/xml

default

Response codes found in response codes.

returns geo-regions

GET /cloud-infrastructure/geo-regions

Tags: CloudInfrastructure

returns geo-regions
geo-region-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

200 OK

successful operation

/geo-regions
default

Response codes found in response codes.

returns geo-region

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

Tags: CloudInfrastructure

returns geo-region
geo-region-id

UUID, key for geo-region object.

 path string

application/json application/xml

200 OK

successful operation

/geo-region
default

Response codes found in response codes.

create or update an existing geo-region

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

Tags: CloudInfrastructure

create or update an existing geo-region

application/json application/xml

geo-region object that needs to be created or updated.

/geo-region
geo-region-id

UUID, key for geo-region object.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing geo-region

PATCH /cloud-infrastructure/geo-regions/geo-region/{geo-region-id}

Tags: CloudInfrastructure

update an existing geo-region

application/json application/xml

geo-region object that needs to be updated.

/zzzz-patch-geo-region
geo-region-id

UUID, key for geo-region object.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing geo-region

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
geo-region-id

UUID, key for geo-region object.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

delete an existing relationship

application/json application/xml

geo-region-id

UUID, key for geo-region object.

 path string

application/json application/xml

default

Response codes found in response codes.

returns network-profiles

GET /cloud-infrastructure/network-profiles

Tags: CloudInfrastructure

returns network-profiles
nm-profile-name

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

200 OK

successful operation

/network-profiles
default

Response codes found in response codes.

returns network-profile

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

Tags: CloudInfrastructure

returns network-profile
nm-profile-name

Unique name of network profile.

 path string

application/json application/xml

200 OK

successful operation

/network-profile
default

Response codes found in response codes.

create or update an existing network-profile

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

Tags: CloudInfrastructure

create or update an existing network-profile

application/json application/xml

network-profile object that needs to be created or updated.

/network-profile
nm-profile-name

Unique name of network profile.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing network-profile

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

Tags: CloudInfrastructure

update an existing network-profile

application/json application/xml

network-profile object that needs to be updated.

/zzzz-patch-network-profile
nm-profile-name

Unique name of network profile.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing network-profile

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
nm-profile-name

Unique name of network profile.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

delete an existing relationship

application/json application/xml

nm-profile-name

Unique name of network profile.

 path string

application/json application/xml

default

Response codes found in response codes.

returns network-technologies

GET /cloud-infrastructure/network-technologies

Tags: CloudInfrastructure

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

200 OK

successful operation

/network-technologies
default

Response codes found in response codes.

returns network-technology

GET /cloud-infrastructure/network-technologies/network-technology/{network-technology-id}

Tags: CloudInfrastructure

returns network-technology
network-technology-id

Unique identifier of the network-technology object (UUID)

 path string

application/json application/xml

200 OK

successful operation

/network-technology
default

Response codes found in response codes.

create or update an existing network-technology

PUT /cloud-infrastructure/network-technologies/network-technology/{network-technology-id}

Tags: CloudInfrastructure

create or update an existing network-technology

application/json application/xml

network-technology object that needs to be created or updated.

/network-technology
network-technology-id

Unique identifier of the network-technology object (UUID)

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing network-technology

PATCH /cloud-infrastructure/network-technologies/network-technology/{network-technology-id}

Tags: CloudInfrastructure

update an existing network-technology

application/json application/xml

network-technology object that needs to be updated.

/zzzz-patch-network-technology
network-technology-id

Unique identifier of the network-technology object (UUID)

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing network-technology

DELETE /cloud-infrastructure/network-technologies/network-technology/{network-technology-id}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/network-technologies/network-technology/{network-technology-id}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
network-technology-id

Unique identifier of the network-technology object (UUID)

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/network-technologies/network-technology/{network-technology-id}/relationship-list/relationship

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns operational-environments

GET /cloud-infrastructure/operational-environments

Tags: CloudInfrastructure

returns operational-environments
operational-environment-id

n/a

 query string
tenant-context

n/a

 query string
workload-context

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

200 OK

successful operation

/operational-environments
default

Response codes found in response codes.

returns operational-environment

GET /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}

Tags: CloudInfrastructure

returns operational-environment
operational-environment-id

UUID of an operational environment

 path string

application/json application/xml

200 OK

successful operation

/operational-environment
default

Response codes found in response codes.

create or update an existing operational-environment

PUT /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}

Tags: CloudInfrastructure

create or update an existing operational-environment

application/json application/xml

operational-environment object that needs to be created or updated.

/operational-environment
operational-environment-id

UUID of an operational environment

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing operational-environment

PATCH /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}

Tags: CloudInfrastructure

update an existing operational-environment

application/json application/xml

operational-environment object that needs to be updated.

/zzzz-patch-operational-environment
operational-environment-id

UUID of an operational environment

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing operational-environment

DELETE /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
operational-environment-id

UUID of an operational environment

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}/relationship-list/relationship

Tags: CloudInfrastructure

delete an existing relationship

application/json application/xml

operational-environment-id

UUID of an operational environment

 path string

application/json application/xml

default

Response codes found in response codes.

returns pservers

GET /cloud-infrastructure/pservers

Tags: CloudInfrastructure

returns pservers
hostname

n/a

 query string
ptnii-equip-name

n/a

 query string
equip-vendor

n/a

 query string
equip-model

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
role

n/a

 query string
function

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

200 OK

successful operation

/pservers
default

Response codes found in response codes.

returns pserver

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

Tags: CloudInfrastructure

returns pserver
hostname

Value from executing hostname on the compute node.

 path string

application/json application/xml

200 OK

successful operation

/pserver
default

Response codes found in response codes.

create or update an existing pserver

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

Tags: CloudInfrastructure

create or update an existing pserver

application/json application/xml

pserver object that needs to be created or updated.

/pserver
hostname

Value from executing hostname on the compute node.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing pserver

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

Tags: CloudInfrastructure

update an existing pserver

application/json application/xml

pserver object that needs to be updated.

/zzzz-patch-pserver
hostname

Value from executing hostname on the compute node.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing pserver

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns activities

GET /cloud-infrastructure/pservers/pserver/{hostname}/activities

Tags: CloudInfrastructure

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

200 OK

successful operation

/activities
default

Response codes found in response codes.

returns activity

GET /cloud-infrastructure/pservers/pserver/{hostname}/activities/activity/{activity-id}

Tags: CloudInfrastructure

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

200 OK

successful operation

/activity
default

Response codes found in response codes.

create or update an existing activity

PUT /cloud-infrastructure/pservers/pserver/{hostname}/activities/activity/{activity-id}

Tags: CloudInfrastructure

create or update an existing activity

application/json application/xml

activity object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing activity

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/activities/activity/{activity-id}

Tags: CloudInfrastructure

update an existing activity

application/json application/xml

activity object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing activity

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/activities/activity/{activity-id}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns activity-states

GET /cloud-infrastructure/pservers/pserver/{hostname}/activities/activity/{activity-id}/activity-states

Tags: CloudInfrastructure

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

200 OK

successful operation

/activity-states
default

Response codes found in response codes.

returns activity-state

GET /cloud-infrastructure/pservers/pserver/{hostname}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

Tags: CloudInfrastructure

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

200 OK

successful operation

/activity-state
default

Response codes found in response codes.

create or update an existing activity-state

PUT /cloud-infrastructure/pservers/pserver/{hostname}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

Tags: CloudInfrastructure

create or update an existing activity-state

application/json application/xml

activity-state object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing activity-state

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

Tags: CloudInfrastructure

update an existing activity-state

application/json application/xml

activity-state object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing activity-state

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/pservers/pserver/{hostname}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}/relationship-list/relationship

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns hpa-capacity

GET /cloud-infrastructure/pservers/pserver/{hostname}/hpa-capacity/{hpa-capacity-key}

Tags: CloudInfrastructure

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

200 OK

successful operation

/hpa-capacity
default

Response codes found in response codes.

create or update an existing hpa-capacity

PUT /cloud-infrastructure/pservers/pserver/{hostname}/hpa-capacity/{hpa-capacity-key}

Tags: CloudInfrastructure

create or update an existing hpa-capacity

application/json application/xml

hpa-capacity object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing hpa-capacity

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/hpa-capacity/{hpa-capacity-key}

Tags: CloudInfrastructure

update an existing hpa-capacity

application/json application/xml

hpa-capacity object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing hpa-capacity

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/hpa-capacity/{hpa-capacity-key}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns l-interfaces

GET /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces

Tags: CloudInfrastructure

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/l-interfaces
default

Response codes found in response codes.

returns l-interface

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

Tags: CloudInfrastructure

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

200 OK

successful operation

/l-interface
default

Response codes found in response codes.

create or update an existing l-interface

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

Tags: CloudInfrastructure

create or update an existing l-interface

application/json application/xml

l-interface object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing l-interface

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

Tags: CloudInfrastructure

update an existing l-interface

application/json application/xml

l-interface object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l-interface

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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

200 OK

successful operation

/l3-interface-ipv4-address-list
default

Response codes found in response codes.

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

PUT /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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.

/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

default

Response codes found in response codes.

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

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

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

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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

200 OK

successful operation

/l3-interface-ipv6-address-list
default

Response codes found in response codes.

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

PUT /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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.

/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

default

Response codes found in response codes.

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

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

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

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns lcmp-unreachables

GET /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables

Tags: CloudInfrastructure

returns lcmp-unreachables
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name given to the interface

 path string
lcmp-unreachable-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

200 OK

successful operation

/lcmp-unreachables
default

Response codes found in response codes.

returns lcmp-unreachable

GET /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: CloudInfrastructure

returns lcmp-unreachable
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name given to the interface

 path string
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

200 OK

successful operation

/lcmp-unreachable
default

Response codes found in response codes.

create or update an existing lcmp-unreachable

PUT /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: CloudInfrastructure

create or update an existing lcmp-unreachable

application/json application/xml

lcmp-unreachable object that needs to be created or updated.

/lcmp-unreachable
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name given to the interface

 path string
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing lcmp-unreachable

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: CloudInfrastructure

update an existing lcmp-unreachable

application/json application/xml

lcmp-unreachable object that needs to be updated.

/zzzz-patch-lcmp-unreachable
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name given to the interface

 path string
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing lcmp-unreachable

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: CloudInfrastructure

delete an existing lcmp-unreachable

application/json application/xml

hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name given to the interface

 path string
lcmp-unreachable-id

object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name given to the interface

 path string
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

Tags: CloudInfrastructure

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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name given to the interface

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns sriov-vfs

GET /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/sriov-vfs

Tags: CloudInfrastructure

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string
neutron-network-id

n/a

 query string

application/json application/xml

200 OK

successful operation

/sriov-vfs
default

Response codes found in response codes.

returns sriov-vf

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

Tags: CloudInfrastructure

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

200 OK

successful operation

/sriov-vf
default

Response codes found in response codes.

create or update an existing sriov-vf

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

Tags: CloudInfrastructure

create or update an existing sriov-vf

application/json application/xml

sriov-vf object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing sriov-vf

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

Tags: CloudInfrastructure

update an existing sriov-vf

application/json application/xml

sriov-vf object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing sriov-vf

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns temporary-parameter-lists

GET /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists

Tags: CloudInfrastructure

returns temporary-parameter-lists
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name given to the interface

 path string
temporary-parameter-list-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

200 OK

successful operation

/temporary-parameter-lists
default

Response codes found in response codes.

returns temporary-parameter-list

GET /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: CloudInfrastructure

returns temporary-parameter-list
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name given to the interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

200 OK

successful operation

/temporary-parameter-list
default

Response codes found in response codes.

create or update an existing temporary-parameter-list

PUT /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: CloudInfrastructure

create or update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be created or updated.

/temporary-parameter-list
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name given to the interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing temporary-parameter-list

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: CloudInfrastructure

update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be updated.

/zzzz-patch-temporary-parameter-list
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name given to the interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing temporary-parameter-list

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: CloudInfrastructure

delete an existing temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name given to the interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: CloudInfrastructure

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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

returns vlans

GET /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/vlans

Tags: CloudInfrastructure

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
vlan-id-outer

n/a

 query integer
vlan-type

n/a

 query string
vpn-key

n/a

 query string
orchestration-status

n/a

 query string
prov-status

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

200 OK

successful operation

/vlans
default

Response codes found in response codes.

returns vlan

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

Tags: CloudInfrastructure

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

200 OK

successful operation

/vlan
default

Response codes found in response codes.

create or update an existing vlan

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

Tags: CloudInfrastructure

create or update an existing vlan

application/json application/xml

vlan object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing vlan

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

Tags: CloudInfrastructure

update an existing vlan

application/json application/xml

vlan object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing vlan

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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

200 OK

successful operation

/l3-interface-ipv4-address-list
default

Response codes found in response codes.

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

PUT /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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.

/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

default

Response codes found in response codes.

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

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

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

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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

200 OK

successful operation

/l3-interface-ipv6-address-list
default

Response codes found in response codes.

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

PUT /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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.

/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

default

Response codes found in response codes.

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

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

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

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns lag-interfaces

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces

Tags: CloudInfrastructure

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string
interface-type

n/a

 query string

application/json application/xml

200 OK

successful operation

/lag-interfaces
default

Response codes found in response codes.

returns lag-interface

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

Tags: CloudInfrastructure

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

200 OK

successful operation

/lag-interface
default

Response codes found in response codes.

create or update an existing lag-interface

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

Tags: CloudInfrastructure

create or update an existing lag-interface

application/json application/xml

lag-interface object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing lag-interface

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

Tags: CloudInfrastructure

update an existing lag-interface

application/json application/xml

lag-interface object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing lag-interface

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns aggregated-ether-options

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options

Tags: CloudInfrastructure

returns aggregated-ether-options
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
aggregated-ether-option-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

200 OK

successful operation

/aggregated-ether-options
default

Response codes found in response codes.

returns aggregated-ether-option

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}

Tags: CloudInfrastructure

returns aggregated-ether-option
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
aggregated-ether-option-id

UUID - unique object identifier

 path string

application/json application/xml

200 OK

successful operation

/aggregated-ether-option
default

Response codes found in response codes.

create or update an existing aggregated-ether-option

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}

Tags: CloudInfrastructure

create or update an existing aggregated-ether-option

application/json application/xml

aggregated-ether-option object that needs to be created or updated.

/aggregated-ether-option
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
aggregated-ether-option-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing aggregated-ether-option

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}

Tags: CloudInfrastructure

update an existing aggregated-ether-option

application/json application/xml

aggregated-ether-option object that needs to be updated.

/zzzz-patch-aggregated-ether-option
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
aggregated-ether-option-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing aggregated-ether-option

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}

Tags: CloudInfrastructure

delete an existing aggregated-ether-option

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
aggregated-ether-option-id

UUID - unique object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

returns lacps

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps

Tags: CloudInfrastructure

returns lacps
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
aggregated-ether-option-id

UUID - unique object identifier

 path string
lacp-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

200 OK

successful operation

/lacps
default

Response codes found in response codes.

returns lacp

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}

Tags: CloudInfrastructure

returns lacp
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
aggregated-ether-option-id

UUID - unique object identifier

 path string
lacp-id

UUID- unique object identifier

 path string

application/json application/xml

200 OK

successful operation

/lacp
default

Response codes found in response codes.

create or update an existing lacp

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}

Tags: CloudInfrastructure

create or update an existing lacp

application/json application/xml

lacp object that needs to be created or updated.

/lacp
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
aggregated-ether-option-id

UUID - unique object identifier

 path string
lacp-id

UUID- unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing lacp

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}

Tags: CloudInfrastructure

update an existing lacp

application/json application/xml

lacp object that needs to be updated.

/zzzz-patch-lacp
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
aggregated-ether-option-id

UUID - unique object identifier

 path string
lacp-id

UUID- unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing lacp

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}

Tags: CloudInfrastructure

delete an existing lacp

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
aggregated-ether-option-id

UUID - unique object identifier

 path string
lacp-id

UUID- unique object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
aggregated-ether-option-id

UUID - unique object identifier

 path string
lacp-id

UUID- unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}/relationship-list/relationship

Tags: CloudInfrastructure

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
aggregated-ether-option-id

UUID - unique object identifier

 path string
lacp-id

UUID- unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
aggregated-ether-option-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/relationship-list/relationship

Tags: CloudInfrastructure

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
aggregated-ether-option-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

returns esis

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

Tags: CloudInfrastructure

returns esis
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
esi-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

200 OK

successful operation

/esis
default

Response codes found in response codes.

returns esi

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}

Tags: CloudInfrastructure

returns esi
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
esi-id

object identifier

 path string

application/json application/xml

200 OK

successful operation

/esi
default

Response codes found in response codes.

create or update an existing esi

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

Tags: CloudInfrastructure

create or update an existing esi

application/json application/xml

esi object that needs to be created or updated.

/esi
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
esi-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing esi

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}

Tags: CloudInfrastructure

update an existing esi

application/json application/xml

esi object that needs to be updated.

/zzzz-patch-esi
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
esi-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing esi

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

Tags: CloudInfrastructure

delete an existing esi

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
esi-id

object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
esi-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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
esi-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

returns l-interfaces

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

Tags: CloudInfrastructure

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/l-interfaces
default

Response codes found in response codes.

returns l-interface

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

Tags: CloudInfrastructure

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

200 OK

successful operation

/l-interface
default

Response codes found in response codes.

create or update an existing l-interface

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

Tags: CloudInfrastructure

create or update an existing l-interface

application/json application/xml

l-interface object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing l-interface

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

Tags: CloudInfrastructure

update an existing l-interface

application/json application/xml

l-interface object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l-interface

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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

200 OK

successful operation

/l3-interface-ipv4-address-list
default

Response codes found in response codes.

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

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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.

/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

default

Response codes found in response codes.

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

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

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

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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

200 OK

successful operation

/l3-interface-ipv6-address-list
default

Response codes found in response codes.

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

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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.

/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

default

Response codes found in response codes.

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

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

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

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns lcmp-unreachables

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables

Tags: CloudInfrastructure

returns lcmp-unreachables
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
lcmp-unreachable-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

200 OK

successful operation

/lcmp-unreachables
default

Response codes found in response codes.

returns lcmp-unreachable

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: CloudInfrastructure

returns lcmp-unreachable
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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

200 OK

successful operation

/lcmp-unreachable
default

Response codes found in response codes.

create or update an existing lcmp-unreachable

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: CloudInfrastructure

create or update an existing lcmp-unreachable

application/json application/xml

lcmp-unreachable object that needs to be created or updated.

/lcmp-unreachable
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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing lcmp-unreachable

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: CloudInfrastructure

update an existing lcmp-unreachable

application/json application/xml

lcmp-unreachable object that needs to be updated.

/zzzz-patch-lcmp-unreachable
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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing lcmp-unreachable

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: CloudInfrastructure

delete an existing lcmp-unreachable

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
lcmp-unreachable-id

object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

Tags: CloudInfrastructure

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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns sriov-vfs

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs

Tags: CloudInfrastructure

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string
neutron-network-id

n/a

 query string

application/json application/xml

200 OK

successful operation

/sriov-vfs
default

Response codes found in response codes.

returns sriov-vf

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

Tags: CloudInfrastructure

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

200 OK

successful operation

/sriov-vf
default

Response codes found in response codes.

create or update an existing sriov-vf

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

Tags: CloudInfrastructure

create or update an existing sriov-vf

application/json application/xml

sriov-vf object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing sriov-vf

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

Tags: CloudInfrastructure

update an existing sriov-vf

application/json application/xml

sriov-vf object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing sriov-vf

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns temporary-parameter-lists

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists

Tags: CloudInfrastructure

returns temporary-parameter-lists
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
temporary-parameter-list-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

200 OK

successful operation

/temporary-parameter-lists
default

Response codes found in response codes.

returns temporary-parameter-list

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: CloudInfrastructure

returns temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

200 OK

successful operation

/temporary-parameter-list
default

Response codes found in response codes.

create or update an existing temporary-parameter-list

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: CloudInfrastructure

create or update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be created or updated.

/temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing temporary-parameter-list

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: CloudInfrastructure

update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be updated.

/zzzz-patch-temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing temporary-parameter-list

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: CloudInfrastructure

delete an existing temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: CloudInfrastructure

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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

returns vlans

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans

Tags: CloudInfrastructure

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
vlan-id-outer

n/a

 query integer
vlan-type

n/a

 query string
vpn-key

n/a

 query string
orchestration-status

n/a

 query string
prov-status

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

200 OK

successful operation

/vlans
default

Response codes found in response codes.

returns vlan

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

Tags: CloudInfrastructure

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

200 OK

successful operation

/vlan
default

Response codes found in response codes.

create or update an existing vlan

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

Tags: CloudInfrastructure

create or update an existing vlan

application/json application/xml

vlan object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing vlan

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

Tags: CloudInfrastructure

update an existing vlan

application/json application/xml

vlan object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing vlan

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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

200 OK

successful operation

/l3-interface-ipv4-address-list
default

Response codes found in response codes.

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

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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.

/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

default

Response codes found in response codes.

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

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

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

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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

200 OK

successful operation

/l3-interface-ipv6-address-list
default

Response codes found in response codes.

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

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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.

/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

default

Response codes found in response codes.

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

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

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

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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

200 OK

successful operation

/l3-interface-ipv4-address-list
default

Response codes found in response codes.

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

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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.

/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

default

Response codes found in response codes.

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

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

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

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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

200 OK

successful operation

/l3-interface-ipv6-address-list
default

Response codes found in response codes.

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

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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.

/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

default

Response codes found in response codes.

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

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

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

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns temporary-parameter-lists

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists

Tags: CloudInfrastructure

returns temporary-parameter-lists
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
temporary-parameter-list-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

200 OK

successful operation

/temporary-parameter-lists
default

Response codes found in response codes.

returns temporary-parameter-list

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: CloudInfrastructure

returns temporary-parameter-list
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

200 OK

successful operation

/temporary-parameter-list
default

Response codes found in response codes.

create or update an existing temporary-parameter-list

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: CloudInfrastructure

create or update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be created or updated.

/temporary-parameter-list
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing temporary-parameter-list

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: CloudInfrastructure

update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be updated.

/zzzz-patch-temporary-parameter-list
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing temporary-parameter-list

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: CloudInfrastructure

delete an existing temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

returns p-interfaces

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces

Tags: CloudInfrastructure

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
interface-type

n/a

 query string
prov-status

n/a

 query string
inv-status

n/a

 query string
interface-function

n/a

 query string
macaddr

n/a

 query string
network-ref

n/a

 query string
operational-status

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

200 OK

successful operation

/p-interfaces
default

Response codes found in response codes.

returns p-interface

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

Tags: CloudInfrastructure

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

200 OK

successful operation

/p-interface
default

Response codes found in response codes.

create or update an existing p-interface

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

Tags: CloudInfrastructure

create or update an existing p-interface

application/json application/xml

p-interface object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing p-interface

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

Tags: CloudInfrastructure

update an existing p-interface

application/json application/xml

p-interface object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing p-interface

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns activities

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

Tags: CloudInfrastructure

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

200 OK

successful operation

/activities
default

Response codes found in response codes.

returns activity

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}

Tags: CloudInfrastructure

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

200 OK

successful operation

/activity
default

Response codes found in response codes.

create or update an existing activity

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

Tags: CloudInfrastructure

create or update an existing activity

application/json application/xml

activity object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing activity

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}

Tags: CloudInfrastructure

update an existing activity

application/json application/xml

activity object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing activity

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns activity-states

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states

Tags: CloudInfrastructure

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

200 OK

successful operation

/activity-states
default

Response codes found in response codes.

returns activity-state

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

Tags: CloudInfrastructure

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

200 OK

successful operation

/activity-state
default

Response codes found in response codes.

create or update an existing activity-state

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

Tags: CloudInfrastructure

create or update an existing activity-state

application/json application/xml

activity-state object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing activity-state

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

Tags: CloudInfrastructure

update an existing activity-state

application/json application/xml

activity-state object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing activity-state

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}/relationship-list/relationship

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns bandwidth-attributes

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes

Tags: CloudInfrastructure

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/bandwidth-attributes
default

Response codes found in response codes.

returns bandwidth-attribute

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}

Tags: CloudInfrastructure

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

200 OK

successful operation

/bandwidth-attribute
default

Response codes found in response codes.

create or update an existing bandwidth-attribute

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}

Tags: CloudInfrastructure

create or update an existing bandwidth-attribute

application/json application/xml

bandwidth-attribute object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing bandwidth-attribute

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}

Tags: CloudInfrastructure

update an existing bandwidth-attribute

application/json application/xml

bandwidth-attribute object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing bandwidth-attribute

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns available-bandwidth-map

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map

Tags: CloudInfrastructure

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/available-bandwidth-map
default

Response codes found in response codes.

returns available-bandwidth

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}

Tags: CloudInfrastructure

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

200 OK

successful operation

/available-bandwidth
default

Response codes found in response codes.

create or update an existing available-bandwidth

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}

Tags: CloudInfrastructure

create or update an existing available-bandwidth

application/json application/xml

available-bandwidth object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing available-bandwidth

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}

Tags: CloudInfrastructure

update an existing available-bandwidth

application/json application/xml

available-bandwidth object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing available-bandwidth

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}/relationship-list/relationship

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/relationship-list/relationship

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns gig-ether-options

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/gig-ether-options

Tags: CloudInfrastructure

returns gig-ether-options
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the physical interface

 path string
gig-ether-option-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

200 OK

successful operation

/gig-ether-options
default

Response codes found in response codes.

returns gig-ether-option

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}

Tags: CloudInfrastructure

returns gig-ether-option
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the physical interface

 path string
gig-ether-option-id

UUID - unique object identifier

 path string

application/json application/xml

200 OK

successful operation

/gig-ether-option
default

Response codes found in response codes.

create or update an existing gig-ether-option

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}

Tags: CloudInfrastructure

create or update an existing gig-ether-option

application/json application/xml

gig-ether-option object that needs to be created or updated.

/gig-ether-option
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the physical interface

 path string
gig-ether-option-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing gig-ether-option

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}

Tags: CloudInfrastructure

update an existing gig-ether-option

application/json application/xml

gig-ether-option object that needs to be updated.

/zzzz-patch-gig-ether-option
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the physical interface

 path string
gig-ether-option-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing gig-ether-option

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}

Tags: CloudInfrastructure

delete an existing gig-ether-option

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
gig-ether-option-id

UUID - unique object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the physical interface

 path string
gig-ether-option-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}/relationship-list/relationship

Tags: CloudInfrastructure

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
gig-ether-option-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

returns hold-timers

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/hold-timers

Tags: CloudInfrastructure

returns hold-timers
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the physical interface

 path string
hold-timer-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

200 OK

successful operation

/hold-timers
default

Response codes found in response codes.

returns hold-timer

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/hold-timers/hold-timer/{hold-timer-id}

Tags: CloudInfrastructure

returns hold-timer
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the physical interface

 path string
hold-timer-id

UUID - unique object identifier

 path string

application/json application/xml

200 OK

successful operation

/hold-timer
default

Response codes found in response codes.

create or update an existing hold-timer

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/hold-timers/hold-timer/{hold-timer-id}

Tags: CloudInfrastructure

create or update an existing hold-timer

application/json application/xml

hold-timer object that needs to be created or updated.

/hold-timer
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the physical interface

 path string
hold-timer-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing hold-timer

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/hold-timers/hold-timer/{hold-timer-id}

Tags: CloudInfrastructure

update an existing hold-timer

application/json application/xml

hold-timer object that needs to be updated.

/zzzz-patch-hold-timer
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the physical interface

 path string
hold-timer-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing hold-timer

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/hold-timers/hold-timer/{hold-timer-id}

Tags: CloudInfrastructure

delete an existing hold-timer

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
hold-timer-id

UUID - unique object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the physical interface

 path string
hold-timer-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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
hold-timer-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

returns l-interfaces

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

Tags: CloudInfrastructure

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/l-interfaces
default

Response codes found in response codes.

returns l-interface

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

Tags: CloudInfrastructure

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

200 OK

successful operation

/l-interface
default

Response codes found in response codes.

create or update an existing l-interface

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

Tags: CloudInfrastructure

create or update an existing l-interface

application/json application/xml

l-interface object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing l-interface

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

Tags: CloudInfrastructure

update an existing l-interface

application/json application/xml

l-interface object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l-interface

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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

200 OK

successful operation

/l3-interface-ipv4-address-list
default

Response codes found in response codes.

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

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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.

/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

default

Response codes found in response codes.

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

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

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

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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

200 OK

successful operation

/l3-interface-ipv6-address-list
default

Response codes found in response codes.

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

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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.

/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

default

Response codes found in response codes.

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

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

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

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns lcmp-unreachables

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables

Tags: CloudInfrastructure

returns lcmp-unreachables
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
lcmp-unreachable-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

200 OK

successful operation

/lcmp-unreachables
default

Response codes found in response codes.

returns lcmp-unreachable

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: CloudInfrastructure

returns lcmp-unreachable
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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

200 OK

successful operation

/lcmp-unreachable
default

Response codes found in response codes.

create or update an existing lcmp-unreachable

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: CloudInfrastructure

create or update an existing lcmp-unreachable

application/json application/xml

lcmp-unreachable object that needs to be created or updated.

/lcmp-unreachable
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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing lcmp-unreachable

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: CloudInfrastructure

update an existing lcmp-unreachable

application/json application/xml

lcmp-unreachable object that needs to be updated.

/zzzz-patch-lcmp-unreachable
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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing lcmp-unreachable

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: CloudInfrastructure

delete an existing lcmp-unreachable

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
lcmp-unreachable-id

object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

Tags: CloudInfrastructure

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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns sriov-vfs

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs

Tags: CloudInfrastructure

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string
neutron-network-id

n/a

 query string

application/json application/xml

200 OK

successful operation

/sriov-vfs
default

Response codes found in response codes.

returns sriov-vf

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

Tags: CloudInfrastructure

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

200 OK

successful operation

/sriov-vf
default

Response codes found in response codes.

create or update an existing sriov-vf

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

Tags: CloudInfrastructure

create or update an existing sriov-vf

application/json application/xml

sriov-vf object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing sriov-vf

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

Tags: CloudInfrastructure

update an existing sriov-vf

application/json application/xml

sriov-vf object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing sriov-vf

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns temporary-parameter-lists

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists

Tags: CloudInfrastructure

returns temporary-parameter-lists
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
temporary-parameter-list-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

200 OK

successful operation

/temporary-parameter-lists
default

Response codes found in response codes.

returns temporary-parameter-list

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: CloudInfrastructure

returns temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

200 OK

successful operation

/temporary-parameter-list
default

Response codes found in response codes.

create or update an existing temporary-parameter-list

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: CloudInfrastructure

create or update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be created or updated.

/temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing temporary-parameter-list

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: CloudInfrastructure

update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be updated.

/zzzz-patch-temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing temporary-parameter-list

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: CloudInfrastructure

delete an existing temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: CloudInfrastructure

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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

returns vlans

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans

Tags: CloudInfrastructure

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
vlan-id-outer

n/a

 query integer
vlan-type

n/a

 query string
vpn-key

n/a

 query string
orchestration-status

n/a

 query string
prov-status

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

200 OK

successful operation

/vlans
default

Response codes found in response codes.

returns vlan

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

Tags: CloudInfrastructure

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

200 OK

successful operation

/vlan
default

Response codes found in response codes.

create or update an existing vlan

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

Tags: CloudInfrastructure

create or update an existing vlan

application/json application/xml

vlan object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing vlan

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

Tags: CloudInfrastructure

update an existing vlan

application/json application/xml

vlan object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing vlan

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

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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

200 OK

successful operation

/l3-interface-ipv4-address-list
default

Response codes found in response codes.

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

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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.

/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

default

Response codes found in response codes.

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

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

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

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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

200 OK

successful operation

/l3-interface-ipv6-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv6-address-list

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv6-address-list

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv6-address-list

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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

200 OK

successful operation

/l3-interface-ipv4-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv4-address-list

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv4-address-list

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv4-address-list

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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

200 OK

successful operation

/l3-interface-ipv6-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv6-address-list

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv6-address-list

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv6-address-list

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns sriov-pfs

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs

Tags: CloudInfrastructure

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/sriov-pfs
default

Response codes found in response codes.

returns sriov-pf

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

Tags: CloudInfrastructure

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

200 OK

successful operation

/sriov-pf
default

Response codes found in response codes.

create or update an existing sriov-pf

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

Tags: CloudInfrastructure

create or update an existing sriov-pf

application/json application/xml

sriov-pf object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing sriov-pf

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

Tags: CloudInfrastructure

update an existing sriov-pf

application/json application/xml

sriov-pf object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing sriov-pf

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

returns temporary-parameter-lists

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists

Tags: CloudInfrastructure

returns temporary-parameter-lists
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the physical interface

 path string
temporary-parameter-list-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

200 OK

successful operation

/temporary-parameter-lists
default

Response codes found in response codes.

returns temporary-parameter-list

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: CloudInfrastructure

returns temporary-parameter-list
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the physical interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

200 OK

successful operation

/temporary-parameter-list
default

Response codes found in response codes.

create or update an existing temporary-parameter-list

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: CloudInfrastructure

create or update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be created or updated.

/temporary-parameter-list
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the physical interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing temporary-parameter-list

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: CloudInfrastructure

update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be updated.

/zzzz-patch-temporary-parameter-list
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the physical interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing temporary-parameter-list

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: CloudInfrastructure

delete an existing temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the physical interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: CloudInfrastructure

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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
hostname

Value from executing hostname on the compute node.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship

Tags: CloudInfrastructure

delete an existing relationship

application/json application/xml

hostname

Value from executing hostname on the compute node.

 path string

application/json application/xml

default

Response codes found in response codes.

returns virtual-data-centers

GET /cloud-infrastructure/virtual-data-centers

Tags: CloudInfrastructure

returns virtual-data-centers
vdc-id

n/a

 query string
vdc-name

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

200 OK

successful operation

/virtual-data-centers
default

Response codes found in response codes.

returns virtual-data-center

GET /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

Tags: CloudInfrastructure

returns virtual-data-center
vdc-id

Unique ID of the vdc

 path string

application/json application/xml

200 OK

successful operation

/virtual-data-center
default

Response codes found in response codes.

create or update an existing virtual-data-center

PUT /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

Tags: CloudInfrastructure

create or update an existing virtual-data-center

application/json application/xml

virtual-data-center object that needs to be created or updated.

/virtual-data-center
vdc-id

Unique ID of the vdc

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing virtual-data-center

PATCH /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

Tags: CloudInfrastructure

update an existing virtual-data-center

application/json application/xml

virtual-data-center object that needs to be updated.

/zzzz-patch-virtual-data-center
vdc-id

Unique ID of the vdc

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing virtual-data-center

DELETE /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

Tags: CloudInfrastructure

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
vdc-id

Unique ID of the vdc

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship

Tags: CloudInfrastructure

delete an existing relationship

application/json application/xml

vdc-id

Unique ID of the vdc

 path string

application/json application/xml

default

Response codes found in response codes.

returns class-map-members

GET /common/class-map-members

Tags: Common

returns class-map-members
class-map-member-id

n/a

 query string
member-type

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

200 OK

successful operation

/class-map-members
default

Response codes found in response codes.

returns class-map-member

GET /common/class-map-members/class-map-member/{class-map-member-id}

Tags: Common

returns class-map-member
class-map-member-id

unique ID

 path string

application/json application/xml

200 OK

successful operation

/class-map-member
default

Response codes found in response codes.

create or update an existing class-map-member

PUT /common/class-map-members/class-map-member/{class-map-member-id}

Tags: Common

create or update an existing class-map-member

application/json application/xml

class-map-member object that needs to be created or updated.

/class-map-member
class-map-member-id

unique ID

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing class-map-member

PATCH /common/class-map-members/class-map-member/{class-map-member-id}

Tags: Common

update an existing class-map-member

application/json application/xml

class-map-member object that needs to be updated.

/zzzz-patch-class-map-member
class-map-member-id

unique ID

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing class-map-member

DELETE /common/class-map-members/class-map-member/{class-map-member-id}

Tags: Common

delete an existing class-map-member

application/json application/xml

class-map-member-id

unique ID

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /common/class-map-members/class-map-member/{class-map-member-id}/relationship-list/relationship

Tags: Common

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
class-map-member-id

unique ID

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /common/class-map-members/class-map-member/{class-map-member-id}/relationship-list/relationship

Tags: Common

delete an existing relationship

application/json application/xml

class-map-member-id

unique ID

 path string

application/json application/xml

default

Response codes found in response codes.

returns class-maps

GET /common/class-maps

Tags: Common

returns class-maps
class-map-id

n/a

 query string
class-map-name

n/a

 query string
class-map-type

n/a

 query string
class-map-role

n/a

 query string
class-map-function

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

200 OK

successful operation

/class-maps
default

Response codes found in response codes.

returns class-map

GET /common/class-maps/class-map/{class-map-id}

Tags: Common

returns class-map
class-map-id

unique ID

 path string

application/json application/xml

200 OK

successful operation

/class-map
default

Response codes found in response codes.

create or update an existing class-map

PUT /common/class-maps/class-map/{class-map-id}

Tags: Common

create or update an existing class-map

application/json application/xml

class-map object that needs to be created or updated.

/class-map
class-map-id

unique ID

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing class-map

PATCH /common/class-maps/class-map/{class-map-id}

Tags: Common

update an existing class-map

application/json application/xml

class-map object that needs to be updated.

/zzzz-patch-class-map
class-map-id

unique ID

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing class-map

DELETE /common/class-maps/class-map/{class-map-id}

Tags: Common

delete an existing class-map

application/json application/xml

class-map-id

unique ID

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /common/class-maps/class-map/{class-map-id}/relationship-list/relationship

Tags: Common

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
class-map-id

unique ID

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /common/class-maps/class-map/{class-map-id}/relationship-list/relationship

Tags: Common

delete an existing relationship

application/json application/xml

class-map-id

unique ID

 path string

application/json application/xml

default

Response codes found in response codes.

returns contacts

GET /common/contacts

Tags: Common

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

200 OK

successful operation

/contacts
default

Response codes found in response codes.

returns contact

GET /common/contacts/contact/{contact-name}

Tags: Common

returns contact
contact-name

Name of the contact

 path string

application/json application/xml

200 OK

successful operation

/contact
default

Response codes found in response codes.

create or update an existing contact

PUT /common/contacts/contact/{contact-name}

Tags: Common

create or update an existing contact

application/json application/xml

contact object that needs to be created or updated.

/contact
contact-name

Name of the contact

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing contact

PATCH /common/contacts/contact/{contact-name}

Tags: Common

update an existing contact

application/json application/xml

contact object that needs to be updated.

/zzzz-patch-contact
contact-name

Name of the contact

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing contact

DELETE /common/contacts/contact/{contact-name}

Tags: Common

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /common/contacts/contact/{contact-name}/relationship-list/relationship

Tags: Common

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
contact-name

Name of the contact

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /common/contacts/contact/{contact-name}/relationship-list/relationship

Tags: Common

delete an existing relationship

application/json application/xml

contact-name

Name of the contact

 path string

application/json application/xml

default

Response codes found in response codes.

returns hardware-catalog-items

GET /common/hardware-catalog-items

Tags: Common

returns hardware-catalog-items
item-name

n/a

 query string
part-number

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

200 OK

successful operation

/hardware-catalog-items
default

Response codes found in response codes.

returns hardware-catalog-item

GET /common/hardware-catalog-items/hardware-catalog-item/{item-name}

Tags: Common

returns hardware-catalog-item
item-name

Unique name for the hardware-catalog-item

 path string

application/json application/xml

200 OK

successful operation

/hardware-catalog-item
default

Response codes found in response codes.

create or update an existing hardware-catalog-item

PUT /common/hardware-catalog-items/hardware-catalog-item/{item-name}

Tags: Common

create or update an existing hardware-catalog-item

application/json application/xml

hardware-catalog-item object that needs to be created or updated.

/hardware-catalog-item
item-name

Unique name for the hardware-catalog-item

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing hardware-catalog-item

PATCH /common/hardware-catalog-items/hardware-catalog-item/{item-name}

Tags: Common

update an existing hardware-catalog-item

application/json application/xml

hardware-catalog-item object that needs to be updated.

/zzzz-patch-hardware-catalog-item
item-name

Unique name for the hardware-catalog-item

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing hardware-catalog-item

DELETE /common/hardware-catalog-items/hardware-catalog-item/{item-name}

Tags: Common

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /common/hardware-catalog-items/hardware-catalog-item/{item-name}/relationship-list/relationship

Tags: Common

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
item-name

Unique name for the hardware-catalog-item

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /common/hardware-catalog-items/hardware-catalog-item/{item-name}/relationship-list/relationship

Tags: Common

delete an existing relationship

application/json application/xml

item-name

Unique name for the hardware-catalog-item

 path string

application/json application/xml

default

Response codes found in response codes.

returns object-groups

GET /common/object-groups

Tags: Common

returns object-groups
object-group-id

n/a

 query string
group-type

n/a

 query string
group-name

n/a

 query string
version

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

200 OK

successful operation

/object-groups
default

Response codes found in response codes.

returns object-group

GET /common/object-groups/object-group/{object-group-id}

Tags: Common

returns object-group
object-group-id

UUID.

 path string

application/json application/xml

200 OK

successful operation

/object-group
default

Response codes found in response codes.

create or update an existing object-group

PUT /common/object-groups/object-group/{object-group-id}

Tags: Common

create or update an existing object-group

application/json application/xml

object-group object that needs to be created or updated.

/object-group
object-group-id

UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing object-group

PATCH /common/object-groups/object-group/{object-group-id}

Tags: Common

update an existing object-group

application/json application/xml

object-group object that needs to be updated.

/zzzz-patch-object-group
object-group-id

UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing object-group

DELETE /common/object-groups/object-group/{object-group-id}

Tags: Common

delete an existing object-group

application/json application/xml

object-group-id

UUID.

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

returns community-list

GET /common/object-groups/object-group/{object-group-id}/community-list/{community-value}

Tags: Common

returns community-list
object-group-id

UUID.

 path string
community-value

String value

 path string

application/json application/xml

200 OK

successful operation

/community-list
default

Response codes found in response codes.

create or update an existing community-list

PUT /common/object-groups/object-group/{object-group-id}/community-list/{community-value}

Tags: Common

create or update an existing community-list

application/json application/xml

community-list object that needs to be created or updated.

/community-list
object-group-id

UUID.

 path string
community-value

String value

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing community-list

PATCH /common/object-groups/object-group/{object-group-id}/community-list/{community-value}

Tags: Common

update an existing community-list

application/json application/xml

community-list object that needs to be updated.

/zzzz-patch-community-list
object-group-id

UUID.

 path string
community-value

String value

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing community-list

DELETE /common/object-groups/object-group/{object-group-id}/community-list/{community-value}

Tags: Common

delete an existing community-list

application/json application/xml

object-group-id

UUID.

 path string
community-value

String value

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /common/object-groups/object-group/{object-group-id}/community-list/{community-value}/relationship-list/relationship

Tags: Common

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
object-group-id

UUID.

 path string
community-value

String value

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /common/object-groups/object-group/{object-group-id}/community-list/{community-value}/relationship-list/relationship

Tags: Common

delete an existing relationship

application/json application/xml

object-group-id

UUID.

 path string
community-value

String value

 path string

application/json application/xml

default

Response codes found in response codes.

returns ip-address-list

GET /common/object-groups/object-group/{object-group-id}/ip-address-list/{ip-address}

Tags: Common

returns ip-address-list
object-group-id

UUID.

 path string
ip-address

IP address

 path string

application/json application/xml

200 OK

successful operation

/ip-address-list
default

Response codes found in response codes.

create or update an existing ip-address-list

PUT /common/object-groups/object-group/{object-group-id}/ip-address-list/{ip-address}

Tags: Common

create or update an existing ip-address-list

application/json application/xml

ip-address-list object that needs to be created or updated.

/ip-address-list
object-group-id

UUID.

 path string
ip-address

IP address

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing ip-address-list

PATCH /common/object-groups/object-group/{object-group-id}/ip-address-list/{ip-address}

Tags: Common

update an existing ip-address-list

application/json application/xml

ip-address-list object that needs to be updated.

/zzzz-patch-ip-address-list
object-group-id

UUID.

 path string
ip-address

IP address

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing ip-address-list

DELETE /common/object-groups/object-group/{object-group-id}/ip-address-list/{ip-address}

Tags: Common

delete an existing ip-address-list

application/json application/xml

object-group-id

UUID.

 path string
ip-address

IP address

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /common/object-groups/object-group/{object-group-id}/ip-address-list/{ip-address}/relationship-list/relationship

Tags: Common

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
object-group-id

UUID.

 path string
ip-address

IP address

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /common/object-groups/object-group/{object-group-id}/ip-address-list/{ip-address}/relationship-list/relationship

Tags: Common

delete an existing relationship

application/json application/xml

object-group-id

UUID.

 path string
ip-address

IP address

 path string

application/json application/xml

default

Response codes found in response codes.

returns port-list

GET /common/object-groups/object-group/{object-group-id}/port-list/{port}

Tags: Common

returns port-list
object-group-id

UUID.

 path string
port

Port number

 path string

application/json application/xml

200 OK

successful operation

/port-list
default

Response codes found in response codes.

create or update an existing port-list

PUT /common/object-groups/object-group/{object-group-id}/port-list/{port}

Tags: Common

create or update an existing port-list

application/json application/xml

port-list object that needs to be created or updated.

/port-list
object-group-id

UUID.

 path string
port

Port number

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing port-list

PATCH /common/object-groups/object-group/{object-group-id}/port-list/{port}

Tags: Common

update an existing port-list

application/json application/xml

port-list object that needs to be updated.

/zzzz-patch-port-list
object-group-id

UUID.

 path string
port

Port number

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing port-list

DELETE /common/object-groups/object-group/{object-group-id}/port-list/{port}

Tags: Common

delete an existing port-list

application/json application/xml

object-group-id

UUID.

 path string
port

Port number

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /common/object-groups/object-group/{object-group-id}/port-list/{port}/relationship-list/relationship

Tags: Common

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
object-group-id

UUID.

 path string
port

Port number

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /common/object-groups/object-group/{object-group-id}/port-list/{port}/relationship-list/relationship

Tags: Common

delete an existing relationship

application/json application/xml

object-group-id

UUID.

 path string
port

Port number

 path string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /common/object-groups/object-group/{object-group-id}/relationship-list/relationship

Tags: Common

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
object-group-id

UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /common/object-groups/object-group/{object-group-id}/relationship-list/relationship

Tags: Common

delete an existing relationship

application/json application/xml

object-group-id

UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

returns selector-list

GET /common/object-groups/object-group/{object-group-id}/selector-list/{selector}

Tags: Common

returns selector-list
object-group-id

UUID.

 path string
selector

Selector

 path string

application/json application/xml

200 OK

successful operation

/selector-list
default

Response codes found in response codes.

create or update an existing selector-list

PUT /common/object-groups/object-group/{object-group-id}/selector-list/{selector}

Tags: Common

create or update an existing selector-list

application/json application/xml

selector-list object that needs to be created or updated.

/selector-list
object-group-id

UUID.

 path string
selector

Selector

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing selector-list

PATCH /common/object-groups/object-group/{object-group-id}/selector-list/{selector}

Tags: Common

update an existing selector-list

application/json application/xml

selector-list object that needs to be updated.

/zzzz-patch-selector-list
object-group-id

UUID.

 path string
selector

Selector

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing selector-list

DELETE /common/object-groups/object-group/{object-group-id}/selector-list/{selector}

Tags: Common

delete an existing selector-list

application/json application/xml

object-group-id

UUID.

 path string
selector

Selector

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /common/object-groups/object-group/{object-group-id}/selector-list/{selector}/relationship-list/relationship

Tags: Common

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
object-group-id

UUID.

 path string
selector

Selector

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /common/object-groups/object-group/{object-group-id}/selector-list/{selector}/relationship-list/relationship

Tags: Common

delete an existing relationship

application/json application/xml

object-group-id

UUID.

 path string
selector

Selector

 path string

application/json application/xml

default

Response codes found in response codes.

returns parameter-lists

GET /common/parameter-lists

Tags: Common

returns parameter-lists
parameter-list-id

n/a

 query string
parameter-type

n/a

 query string
parameter-role

n/a

 query string
parameter-function

n/a

 query string
parameter-name

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

200 OK

successful operation

/parameter-lists
default

Response codes found in response codes.

returns parameter-list

GET /common/parameter-lists/parameter-list/{parameter-list-id}

Tags: Common

returns parameter-list
parameter-list-id

UUID

 path string

application/json application/xml

200 OK

successful operation

/parameter-list
default

Response codes found in response codes.

create or update an existing parameter-list

PUT /common/parameter-lists/parameter-list/{parameter-list-id}

Tags: Common

create or update an existing parameter-list

application/json application/xml

parameter-list object that needs to be created or updated.

/parameter-list
parameter-list-id

UUID

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing parameter-list

PATCH /common/parameter-lists/parameter-list/{parameter-list-id}

Tags: Common

update an existing parameter-list

application/json application/xml

parameter-list object that needs to be updated.

/zzzz-patch-parameter-list
parameter-list-id

UUID

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing parameter-list

DELETE /common/parameter-lists/parameter-list/{parameter-list-id}

Tags: Common

delete an existing parameter-list

application/json application/xml

parameter-list-id

UUID

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /common/parameter-lists/parameter-list/{parameter-list-id}/relationship-list/relationship

Tags: Common

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
parameter-list-id

UUID

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /common/parameter-lists/parameter-list/{parameter-list-id}/relationship-list/relationship

Tags: Common

delete an existing relationship

application/json application/xml

parameter-list-id

UUID

 path string

application/json application/xml

default

Response codes found in response codes.

returns policies

GET /common/policies

Tags: Common

returns policies
policy-id

n/a

 query string
version

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

200 OK

successful operation

/policies
default

Response codes found in response codes.

returns policy

GET /common/policies/policy/{policy-id}

Tags: Common

returns policy
policy-id

Unique Policy UUID.

 path string

application/json application/xml

200 OK

successful operation

/policy
default

Response codes found in response codes.

create or update an existing policy

PUT /common/policies/policy/{policy-id}

Tags: Common

create or update an existing policy

application/json application/xml

policy object that needs to be created or updated.

/policy
policy-id

Unique Policy UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing policy

PATCH /common/policies/policy/{policy-id}

Tags: Common

update an existing policy

application/json application/xml

policy object that needs to be updated.

/zzzz-patch-policy
policy-id

Unique Policy UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing policy

DELETE /common/policies/policy/{policy-id}

Tags: Common

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

default

Response codes found in response codes.

returns ip-address-list

GET /common/policies/policy/{policy-id}/ip-address-list/{ip-address}

Tags: Common

returns ip-address-list
policy-id

Unique Policy UUID.

 path string
ip-address

IP address

 path string

application/json application/xml

200 OK

successful operation

/ip-address-list
default

Response codes found in response codes.

create or update an existing ip-address-list

PUT /common/policies/policy/{policy-id}/ip-address-list/{ip-address}

Tags: Common

create or update an existing ip-address-list

application/json application/xml

ip-address-list object that needs to be created or updated.

/ip-address-list
policy-id

Unique Policy UUID.

 path string
ip-address

IP address

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing ip-address-list

PATCH /common/policies/policy/{policy-id}/ip-address-list/{ip-address}

Tags: Common

update an existing ip-address-list

application/json application/xml

ip-address-list object that needs to be updated.

/zzzz-patch-ip-address-list
policy-id

Unique Policy UUID.

 path string
ip-address

IP address

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing ip-address-list

DELETE /common/policies/policy/{policy-id}/ip-address-list/{ip-address}

Tags: Common

delete an existing ip-address-list

application/json application/xml

policy-id

Unique Policy UUID.

 path string
ip-address

IP address

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /common/policies/policy/{policy-id}/ip-address-list/{ip-address}/relationship-list/relationship

Tags: Common

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
policy-id

Unique Policy UUID.

 path string
ip-address

IP address

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /common/policies/policy/{policy-id}/ip-address-list/{ip-address}/relationship-list/relationship

Tags: Common

delete an existing relationship

application/json application/xml

policy-id

Unique Policy UUID.

 path string
ip-address

IP address

 path string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /common/policies/policy/{policy-id}/relationship-list/relationship

Tags: Common

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
policy-id

Unique Policy UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /common/policies/policy/{policy-id}/relationship-list/relationship

Tags: Common

delete an existing relationship

application/json application/xml

policy-id

Unique Policy UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

returns rules

GET /common/policies/policy/{policy-id}/rules

Tags: Common

returns rules
policy-id

Unique Policy UUID.

 path string
rule-id

n/a

 query string
sequence

n/a

 query integer
version

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

200 OK

successful operation

/rules
default

Response codes found in response codes.

returns rule

GET /common/policies/policy/{policy-id}/rules/rule/{rule-id}

Tags: Common

returns rule
policy-id

Unique Policy UUID.

 path string
rule-id

UUID.

 path string

application/json application/xml

200 OK

successful operation

/rule
default

Response codes found in response codes.

create or update an existing rule

PUT /common/policies/policy/{policy-id}/rules/rule/{rule-id}

Tags: Common

create or update an existing rule

application/json application/xml

rule object that needs to be created or updated.

/rule
policy-id

Unique Policy UUID.

 path string
rule-id

UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing rule

PATCH /common/policies/policy/{policy-id}/rules/rule/{rule-id}

Tags: Common

update an existing rule

application/json application/xml

rule object that needs to be updated.

/zzzz-patch-rule
policy-id

Unique Policy UUID.

 path string
rule-id

UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing rule

DELETE /common/policies/policy/{policy-id}/rules/rule/{rule-id}

Tags: Common

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

default

Response codes found in response codes.

returns ip-address-list

GET /common/policies/policy/{policy-id}/rules/rule/{rule-id}/ip-address-list/{ip-address}

Tags: Common

returns ip-address-list
policy-id

Unique Policy UUID.

 path string
rule-id

UUID.

 path string
ip-address

IP address

 path string

application/json application/xml

200 OK

successful operation

/ip-address-list
default

Response codes found in response codes.

create or update an existing ip-address-list

PUT /common/policies/policy/{policy-id}/rules/rule/{rule-id}/ip-address-list/{ip-address}

Tags: Common

create or update an existing ip-address-list

application/json application/xml

ip-address-list object that needs to be created or updated.

/ip-address-list
policy-id

Unique Policy UUID.

 path string
rule-id

UUID.

 path string
ip-address

IP address

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing ip-address-list

PATCH /common/policies/policy/{policy-id}/rules/rule/{rule-id}/ip-address-list/{ip-address}

Tags: Common

update an existing ip-address-list

application/json application/xml

ip-address-list object that needs to be updated.

/zzzz-patch-ip-address-list
policy-id

Unique Policy UUID.

 path string
rule-id

UUID.

 path string
ip-address

IP address

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing ip-address-list

DELETE /common/policies/policy/{policy-id}/rules/rule/{rule-id}/ip-address-list/{ip-address}

Tags: Common

delete an existing ip-address-list

application/json application/xml

policy-id

Unique Policy UUID.

 path string
rule-id

UUID.

 path string
ip-address

IP address

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /common/policies/policy/{policy-id}/rules/rule/{rule-id}/ip-address-list/{ip-address}/relationship-list/relationship

Tags: Common

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
policy-id

Unique Policy UUID.

 path string
rule-id

UUID.

 path string
ip-address

IP address

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /common/policies/policy/{policy-id}/rules/rule/{rule-id}/ip-address-list/{ip-address}/relationship-list/relationship

Tags: Common

delete an existing relationship

application/json application/xml

policy-id

Unique Policy UUID.

 path string
rule-id

UUID.

 path string
ip-address

IP address

 path string

application/json application/xml

default

Response codes found in response codes.

returns metadata

GET /common/policies/policy/{policy-id}/rules/rule/{rule-id}/metadata

Tags: Common

returns metadata
policy-id

Unique Policy UUID.

 path string
rule-id

UUID.

 path string
metaname

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

200 OK

successful operation

/metadata
default

Response codes found in response codes.

returns metadatum

GET /common/policies/policy/{policy-id}/rules/rule/{rule-id}/metadata/metadatum/{metaname}

Tags: Common

returns metadatum
policy-id

Unique Policy UUID.

 path string
rule-id

UUID.

 path string
metaname path string

application/json application/xml

200 OK

successful operation

/metadatum
default

Response codes found in response codes.

create or update an existing metadatum

PUT /common/policies/policy/{policy-id}/rules/rule/{rule-id}/metadata/metadatum/{metaname}

Tags: Common

create or update an existing metadatum

application/json application/xml

metadatum object that needs to be created or updated.

/metadatum
policy-id

Unique Policy UUID.

 path string
rule-id

UUID.

 path string
metaname path string

application/json application/xml

default

Response codes found in response codes.

update an existing metadatum

PATCH /common/policies/policy/{policy-id}/rules/rule/{rule-id}/metadata/metadatum/{metaname}

Tags: Common

update an existing metadatum

application/json application/xml

metadatum object that needs to be updated.

/zzzz-patch-metadatum
policy-id

Unique Policy UUID.

 path string
rule-id

UUID.

 path string
metaname path string

application/json application/xml

default

Response codes found in response codes.

delete an existing metadatum

DELETE /common/policies/policy/{policy-id}/rules/rule/{rule-id}/metadata/metadatum/{metaname}

Tags: Common

delete an existing metadatum

application/json application/xml

policy-id

Unique Policy UUID.

 path string
rule-id

UUID.

 path string
metaname path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

returns port-list

GET /common/policies/policy/{policy-id}/rules/rule/{rule-id}/port-list/{port}

Tags: Common

returns port-list
policy-id

Unique Policy UUID.

 path string
rule-id

UUID.

 path string
port

Port number

 path string

application/json application/xml

200 OK

successful operation

/port-list
default

Response codes found in response codes.

create or update an existing port-list

PUT /common/policies/policy/{policy-id}/rules/rule/{rule-id}/port-list/{port}

Tags: Common

create or update an existing port-list

application/json application/xml

port-list object that needs to be created or updated.

/port-list
policy-id

Unique Policy UUID.

 path string
rule-id

UUID.

 path string
port

Port number

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing port-list

PATCH /common/policies/policy/{policy-id}/rules/rule/{rule-id}/port-list/{port}

Tags: Common

update an existing port-list

application/json application/xml

port-list object that needs to be updated.

/zzzz-patch-port-list
policy-id

Unique Policy UUID.

 path string
rule-id

UUID.

 path string
port

Port number

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing port-list

DELETE /common/policies/policy/{policy-id}/rules/rule/{rule-id}/port-list/{port}

Tags: Common

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /common/policies/policy/{policy-id}/rules/rule/{rule-id}/port-list/{port}/relationship-list/relationship

Tags: Common

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
policy-id

Unique Policy UUID.

 path string
rule-id

UUID.

 path string
port

Port number

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /common/policies/policy/{policy-id}/rules/rule/{rule-id}/port-list/{port}/relationship-list/relationship

Tags: Common

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /common/policies/policy/{policy-id}/rules/rule/{rule-id}/relationship-list/relationship

Tags: Common

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
policy-id

Unique Policy UUID.

 path string
rule-id

UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /common/policies/policy/{policy-id}/rules/rule/{rule-id}/relationship-list/relationship

Tags: Common

delete an existing relationship

application/json application/xml

policy-id

Unique Policy UUID.

 path string
rule-id

UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

returns selector-list

GET /common/policies/policy/{policy-id}/rules/rule/{rule-id}/selector-list/{selector}

Tags: Common

returns selector-list
policy-id

Unique Policy UUID.

 path string
rule-id

UUID.

 path string
selector

Selector

 path string

application/json application/xml

200 OK

successful operation

/selector-list
default

Response codes found in response codes.

create or update an existing selector-list

PUT /common/policies/policy/{policy-id}/rules/rule/{rule-id}/selector-list/{selector}

Tags: Common

create or update an existing selector-list

application/json application/xml

selector-list object that needs to be created or updated.

/selector-list
policy-id

Unique Policy UUID.

 path string
rule-id

UUID.

 path string
selector

Selector

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing selector-list

PATCH /common/policies/policy/{policy-id}/rules/rule/{rule-id}/selector-list/{selector}

Tags: Common

update an existing selector-list

application/json application/xml

selector-list object that needs to be updated.

/zzzz-patch-selector-list
policy-id

Unique Policy UUID.

 path string
rule-id

UUID.

 path string
selector

Selector

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing selector-list

DELETE /common/policies/policy/{policy-id}/rules/rule/{rule-id}/selector-list/{selector}

Tags: Common

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /common/policies/policy/{policy-id}/rules/rule/{rule-id}/selector-list/{selector}/relationship-list/relationship

Tags: Common

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
policy-id

Unique Policy UUID.

 path string
rule-id

UUID.

 path string
selector

Selector

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /common/policies/policy/{policy-id}/rules/rule/{rule-id}/selector-list/{selector}/relationship-list/relationship

Tags: Common

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

default

Response codes found in response codes.

returns selector-list

GET /common/policies/policy/{policy-id}/selector-list/{selector}

Tags: Common

returns selector-list
policy-id

Unique Policy UUID.

 path string
selector

Selector

 path string

application/json application/xml

200 OK

successful operation

/selector-list
default

Response codes found in response codes.

create or update an existing selector-list

PUT /common/policies/policy/{policy-id}/selector-list/{selector}

Tags: Common

create or update an existing selector-list

application/json application/xml

selector-list object that needs to be created or updated.

/selector-list
policy-id

Unique Policy UUID.

 path string
selector

Selector

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing selector-list

PATCH /common/policies/policy/{policy-id}/selector-list/{selector}

Tags: Common

update an existing selector-list

application/json application/xml

selector-list object that needs to be updated.

/zzzz-patch-selector-list
policy-id

Unique Policy UUID.

 path string
selector

Selector

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing selector-list

DELETE /common/policies/policy/{policy-id}/selector-list/{selector}

Tags: Common

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /common/policies/policy/{policy-id}/selector-list/{selector}/relationship-list/relationship

Tags: Common

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
policy-id

Unique Policy UUID.

 path string
selector

Selector

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /common/policies/policy/{policy-id}/selector-list/{selector}/relationship-list/relationship

Tags: Common

delete an existing relationship

application/json application/xml

policy-id

Unique Policy UUID.

 path string
selector

Selector

 path string

application/json application/xml

default

Response codes found in response codes.

returns policy-key-terms

GET /common/policy-key-terms

Tags: Common

returns policy-key-terms
policy-key-term-id

n/a

 query string
key-word

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

200 OK

successful operation

/policy-key-terms
default

Response codes found in response codes.

returns policy-key-term

GET /common/policy-key-terms/policy-key-term/{policy-key-term-id}

Tags: Common

returns policy-key-term
policy-key-term-id

unique ID

 path string

application/json application/xml

200 OK

successful operation

/policy-key-term
default

Response codes found in response codes.

create or update an existing policy-key-term

PUT /common/policy-key-terms/policy-key-term/{policy-key-term-id}

Tags: Common

create or update an existing policy-key-term

application/json application/xml

policy-key-term object that needs to be created or updated.

/policy-key-term
policy-key-term-id

unique ID

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing policy-key-term

PATCH /common/policy-key-terms/policy-key-term/{policy-key-term-id}

Tags: Common

update an existing policy-key-term

application/json application/xml

policy-key-term object that needs to be updated.

/zzzz-patch-policy-key-term
policy-key-term-id

unique ID

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing policy-key-term

DELETE /common/policy-key-terms/policy-key-term/{policy-key-term-id}

Tags: Common

delete an existing policy-key-term

application/json application/xml

policy-key-term-id

unique ID

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /common/policy-key-terms/policy-key-term/{policy-key-term-id}/relationship-list/relationship

Tags: Common

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
policy-key-term-id

unique ID

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /common/policy-key-terms/policy-key-term/{policy-key-term-id}/relationship-list/relationship

Tags: Common

delete an existing relationship

application/json application/xml

policy-key-term-id

unique ID

 path string

application/json application/xml

default

Response codes found in response codes.

returns policy-map-members

GET /common/policy-map-members

Tags: Common

returns policy-map-members
policy-map-member-id

n/a

 query string
member-type

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

200 OK

successful operation

/policy-map-members
default

Response codes found in response codes.

returns policy-map-member

GET /common/policy-map-members/policy-map-member/{policy-map-member-id}

Tags: Common

returns policy-map-member
policy-map-member-id

unique ID

 path string

application/json application/xml

200 OK

successful operation

/policy-map-member
default

Response codes found in response codes.

create or update an existing policy-map-member

PUT /common/policy-map-members/policy-map-member/{policy-map-member-id}

Tags: Common

create or update an existing policy-map-member

application/json application/xml

policy-map-member object that needs to be created or updated.

/policy-map-member
policy-map-member-id

unique ID

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing policy-map-member

PATCH /common/policy-map-members/policy-map-member/{policy-map-member-id}

Tags: Common

update an existing policy-map-member

application/json application/xml

policy-map-member object that needs to be updated.

/zzzz-patch-policy-map-member
policy-map-member-id

unique ID

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing policy-map-member

DELETE /common/policy-map-members/policy-map-member/{policy-map-member-id}

Tags: Common

delete an existing policy-map-member

application/json application/xml

policy-map-member-id

unique ID

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /common/policy-map-members/policy-map-member/{policy-map-member-id}/relationship-list/relationship

Tags: Common

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
policy-map-member-id

unique ID

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /common/policy-map-members/policy-map-member/{policy-map-member-id}/relationship-list/relationship

Tags: Common

delete an existing relationship

application/json application/xml

policy-map-member-id

unique ID

 path string

application/json application/xml

default

Response codes found in response codes.

returns profiles

GET /common/profiles

Tags: Common

returns profiles
profile-name

n/a

 query string
profile-role

n/a

 query string
profile-function

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

200 OK

successful operation

/profiles
default

Response codes found in response codes.

returns profile

GET /common/profiles/profile/{profile-name}

Tags: Common

returns profile
profile-name

Name of the profile

 path string

application/json application/xml

200 OK

successful operation

/profile
default

Response codes found in response codes.

create or update an existing profile

PUT /common/profiles/profile/{profile-name}

Tags: Common

create or update an existing profile

application/json application/xml

profile object that needs to be created or updated.

/profile
profile-name

Name of the profile

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing profile

PATCH /common/profiles/profile/{profile-name}

Tags: Common

update an existing profile

application/json application/xml

profile object that needs to be updated.

/zzzz-patch-profile
profile-name

Name of the profile

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing profile

DELETE /common/profiles/profile/{profile-name}

Tags: Common

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

default

Response codes found in response codes.

returns metadata

GET /common/profiles/profile/{profile-name}/metadata

Tags: Common

returns metadata
profile-name

Name of the profile

 path string
metaname

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

200 OK

successful operation

/metadata
default

Response codes found in response codes.

returns metadatum

GET /common/profiles/profile/{profile-name}/metadata/metadatum/{metaname}

Tags: Common

returns metadatum
profile-name

Name of the profile

 path string
metaname path string

application/json application/xml

200 OK

successful operation

/metadatum
default

Response codes found in response codes.

create or update an existing metadatum

PUT /common/profiles/profile/{profile-name}/metadata/metadatum/{metaname}

Tags: Common

create or update an existing metadatum

application/json application/xml

metadatum object that needs to be created or updated.

/metadatum
profile-name

Name of the profile

 path string
metaname path string

application/json application/xml

default

Response codes found in response codes.

update an existing metadatum

PATCH /common/profiles/profile/{profile-name}/metadata/metadatum/{metaname}

Tags: Common

update an existing metadatum

application/json application/xml

metadatum object that needs to be updated.

/zzzz-patch-metadatum
profile-name

Name of the profile

 path string
metaname path string

application/json application/xml

default

Response codes found in response codes.

delete an existing metadatum

DELETE /common/profiles/profile/{profile-name}/metadata/metadatum/{metaname}

Tags: Common

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /common/profiles/profile/{profile-name}/relationship-list/relationship

Tags: Common

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
profile-name

Name of the profile

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /common/profiles/profile/{profile-name}/relationship-list/relationship

Tags: Common

delete an existing relationship

application/json application/xml

profile-name

Name of the profile

 path string

application/json application/xml

default

Response codes found in response codes.

returns relationship-rules

GET /common/relationship-rules

Tags: Common

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/relationship-rules
default

Response codes found in response codes.

returns relationship-rule

GET /common/relationship-rules/relationship-rule/{rule-id}

Tags: Common

returns relationship-rule
rule-id

UUID.

 path string

application/json application/xml

200 OK

successful operation

/relationship-rule
default

Response codes found in response codes.

create or update an existing relationship-rule

PUT /common/relationship-rules/relationship-rule/{rule-id}

Tags: Common

create or update an existing relationship-rule

application/json application/xml

relationship-rule object that needs to be created or updated.

/relationship-rule
rule-id

UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing relationship-rule

PATCH /common/relationship-rules/relationship-rule/{rule-id}

Tags: Common

update an existing relationship-rule

application/json application/xml

relationship-rule object that needs to be updated.

/zzzz-patch-relationship-rule
rule-id

UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship-rule

DELETE /common/relationship-rules/relationship-rule/{rule-id}

Tags: Common

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

default

Response codes found in response codes.

returns relationship-components

GET /common/relationship-rules/relationship-rule/{rule-id}/relationship-components

Tags: Common

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/relationship-components
default

Response codes found in response codes.

returns relationship-component

GET /common/relationship-rules/relationship-rule/{rule-id}/relationship-components/relationship-component/{rule-node}

Tags: Common

returns relationship-component
rule-id

UUID.

 path string
rule-node

NARAD object

 path string

application/json application/xml

200 OK

successful operation

/relationship-component
default

Response codes found in response codes.

create or update an existing relationship-component

PUT /common/relationship-rules/relationship-rule/{rule-id}/relationship-components/relationship-component/{rule-node}

Tags: Common

create or update an existing relationship-component

application/json application/xml

relationship-component object that needs to be created or updated.

/relationship-component
rule-id

UUID.

 path string
rule-node

NARAD object

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing relationship-component

PATCH /common/relationship-rules/relationship-rule/{rule-id}/relationship-components/relationship-component/{rule-node}

Tags: Common

update an existing relationship-component

application/json application/xml

relationship-component object that needs to be updated.

/zzzz-patch-relationship-component
rule-id

UUID.

 path string
rule-node

NARAD object

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship-component

DELETE /common/relationship-rules/relationship-rule/{rule-id}/relationship-components/relationship-component/{rule-node}

Tags: Common

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /common/relationship-rules/relationship-rule/{rule-id}/relationship-components/relationship-component/{rule-node}/relationship-list/relationship

Tags: Common

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
rule-id

UUID.

 path string
rule-node

NARAD object

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /common/relationship-rules/relationship-rule/{rule-id}/relationship-components/relationship-component/{rule-node}/relationship-list/relationship

Tags: Common

delete an existing relationship

application/json application/xml

rule-id

UUID.

 path string
rule-node

NARAD object

 path string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /common/relationship-rules/relationship-rule/{rule-id}/relationship-list/relationship

Tags: Common

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
rule-id

UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /common/relationship-rules/relationship-rule/{rule-id}/relationship-list/relationship

Tags: Common

delete an existing relationship

application/json application/xml

rule-id

UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

returns vlan-characteristics

GET /common/vlan-characteristics

Tags: Common

returns vlan-characteristics
vlan-characteristic-id

n/a

 query string
applies-to

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

200 OK

successful operation

/vlan-characteristics
default

Response codes found in response codes.

returns vlan-characteristic

GET /common/vlan-characteristics/vlan-characteristic/{vlan-characteristic-id}

Tags: Common

returns vlan-characteristic
vlan-characteristic-id

UUID.

 path string

application/json application/xml

200 OK

successful operation

/vlan-characteristic
default

Response codes found in response codes.

create or update an existing vlan-characteristic

PUT /common/vlan-characteristics/vlan-characteristic/{vlan-characteristic-id}

Tags: Common

create or update an existing vlan-characteristic

application/json application/xml

vlan-characteristic object that needs to be created or updated.

/vlan-characteristic
vlan-characteristic-id

UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing vlan-characteristic

PATCH /common/vlan-characteristics/vlan-characteristic/{vlan-characteristic-id}

Tags: Common

update an existing vlan-characteristic

application/json application/xml

vlan-characteristic object that needs to be updated.

/zzzz-patch-vlan-characteristic
vlan-characteristic-id

UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing vlan-characteristic

DELETE /common/vlan-characteristics/vlan-characteristic/{vlan-characteristic-id}

Tags: Common

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /common/vlan-characteristics/vlan-characteristic/{vlan-characteristic-id}/relationship-list/relationship

Tags: Common

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
vlan-characteristic-id

UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /common/vlan-characteristics/vlan-characteristic/{vlan-characteristic-id}/relationship-list/relationship

Tags: Common

delete an existing relationship

application/json application/xml

vlan-characteristic-id

UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

returns esr-ems-list

GET /external-system/esr-ems-list

Tags: ExternalSystem

returns esr-ems-list
ems-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

200 OK

successful operation

/esr-ems-list
default

Response codes found in response codes.

returns esr-ems

GET /external-system/esr-ems-list/esr-ems/{ems-id}

Tags: ExternalSystem

returns esr-ems
ems-id

Unique ID of EMS.

 path string

application/json application/xml

200 OK

successful operation

/esr-ems
default

Response codes found in response codes.

create or update an existing esr-ems

PUT /external-system/esr-ems-list/esr-ems/{ems-id}

Tags: ExternalSystem

create or update an existing esr-ems

application/json application/xml

esr-ems object that needs to be created or updated.

/esr-ems
ems-id

Unique ID of EMS.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing esr-ems

PATCH /external-system/esr-ems-list/esr-ems/{ems-id}

Tags: ExternalSystem

update an existing esr-ems

application/json application/xml

esr-ems object that needs to be updated.

/zzzz-patch-esr-ems
ems-id

Unique ID of EMS.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing esr-ems

DELETE /external-system/esr-ems-list/esr-ems/{ems-id}

Tags: ExternalSystem

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

default

Response codes found in response codes.

returns esr-system-info-list

GET /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list

Tags: ExternalSystem

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/esr-system-info-list
default

Response codes found in response codes.

returns esr-system-info

GET /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

Tags: ExternalSystem

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

200 OK

successful operation

/esr-system-info
default

Response codes found in response codes.

create or update an existing esr-system-info

PUT /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

Tags: ExternalSystem

create or update an existing esr-system-info

application/json application/xml

esr-system-info object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing esr-system-info

PATCH /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

Tags: ExternalSystem

update an existing esr-system-info

application/json application/xml

esr-system-info object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing esr-system-info

DELETE /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

Tags: ExternalSystem

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

Tags: ExternalSystem

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
ems-id

Unique ID of EMS.

 path string
esr-system-info-id

Unique ID of esr system info.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

Tags: ExternalSystem

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /external-system/esr-ems-list/esr-ems/{ems-id}/relationship-list/relationship

Tags: ExternalSystem

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
ems-id

Unique ID of EMS.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /external-system/esr-ems-list/esr-ems/{ems-id}/relationship-list/relationship

Tags: ExternalSystem

delete an existing relationship

application/json application/xml

ems-id

Unique ID of EMS.

 path string

application/json application/xml

default

Response codes found in response codes.

returns esr-nfvo-list

GET /external-system/esr-nfvo-list

Tags: ExternalSystem

returns esr-nfvo-list
nfvo-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

200 OK

successful operation

/esr-nfvo-list
default

Response codes found in response codes.

returns esr-nfvo

GET /external-system/esr-nfvo-list/esr-nfvo/{nfvo-id}

Tags: ExternalSystem

returns esr-nfvo
nfvo-id

Unique ID of nfvo.

 path string

application/json application/xml

200 OK

successful operation

/esr-nfvo
default

Response codes found in response codes.

create or update an existing esr-nfvo

PUT /external-system/esr-nfvo-list/esr-nfvo/{nfvo-id}

Tags: ExternalSystem

create or update an existing esr-nfvo

application/json application/xml

esr-nfvo object that needs to be created or updated.

/esr-nfvo
nfvo-id

Unique ID of nfvo.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing esr-nfvo

PATCH /external-system/esr-nfvo-list/esr-nfvo/{nfvo-id}

Tags: ExternalSystem

update an existing esr-nfvo

application/json application/xml

esr-nfvo object that needs to be updated.

/zzzz-patch-esr-nfvo
nfvo-id

Unique ID of nfvo.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing esr-nfvo

DELETE /external-system/esr-nfvo-list/esr-nfvo/{nfvo-id}

Tags: ExternalSystem

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

default

Response codes found in response codes.

returns esr-system-info-list

GET /external-system/esr-nfvo-list/esr-nfvo/{nfvo-id}/esr-system-info-list

Tags: ExternalSystem

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/esr-system-info-list
default

Response codes found in response codes.

returns esr-system-info

GET /external-system/esr-nfvo-list/esr-nfvo/{nfvo-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

Tags: ExternalSystem

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

200 OK

successful operation

/esr-system-info
default

Response codes found in response codes.

create or update an existing esr-system-info

PUT /external-system/esr-nfvo-list/esr-nfvo/{nfvo-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

Tags: ExternalSystem

create or update an existing esr-system-info

application/json application/xml

esr-system-info object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing esr-system-info

PATCH /external-system/esr-nfvo-list/esr-nfvo/{nfvo-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

Tags: ExternalSystem

update an existing esr-system-info

application/json application/xml

esr-system-info object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing esr-system-info

DELETE /external-system/esr-nfvo-list/esr-nfvo/{nfvo-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

Tags: ExternalSystem

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /external-system/esr-nfvo-list/esr-nfvo/{nfvo-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

Tags: ExternalSystem

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
nfvo-id

Unique ID of nfvo.

 path string
esr-system-info-id

Unique ID of esr system info.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /external-system/esr-nfvo-list/esr-nfvo/{nfvo-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

Tags: ExternalSystem

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /external-system/esr-nfvo-list/esr-nfvo/{nfvo-id}/relationship-list/relationship

Tags: ExternalSystem

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
nfvo-id

Unique ID of nfvo.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /external-system/esr-nfvo-list/esr-nfvo/{nfvo-id}/relationship-list/relationship

Tags: ExternalSystem

delete an existing relationship

application/json application/xml

nfvo-id

Unique ID of nfvo.

 path string

application/json application/xml

default

Response codes found in response codes.

returns esr-thirdparty-sdnc-list

GET /external-system/esr-thirdparty-sdnc-list

Tags: ExternalSystem

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

200 OK

successful operation

/esr-thirdparty-sdnc-list
default

Response codes found in response codes.

returns esr-thirdparty-sdnc

GET /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}

Tags: ExternalSystem

returns esr-thirdparty-sdnc
thirdparty-sdnc-id

Unique ID of SDNC.

 path string

application/json application/xml

200 OK

successful operation

/esr-thirdparty-sdnc
default

Response codes found in response codes.

create or update an existing esr-thirdparty-sdnc

PUT /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}

Tags: ExternalSystem

create or update an existing esr-thirdparty-sdnc

application/json application/xml

esr-thirdparty-sdnc object that needs to be created or updated.

/esr-thirdparty-sdnc
thirdparty-sdnc-id

Unique ID of SDNC.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing esr-thirdparty-sdnc

PATCH /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}

Tags: ExternalSystem

update an existing esr-thirdparty-sdnc

application/json application/xml

esr-thirdparty-sdnc object that needs to be updated.

/zzzz-patch-esr-thirdparty-sdnc
thirdparty-sdnc-id

Unique ID of SDNC.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing esr-thirdparty-sdnc

DELETE /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}

Tags: ExternalSystem

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

default

Response codes found in response codes.

returns esr-system-info-list

GET /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list

Tags: ExternalSystem

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/esr-system-info-list
default

Response codes found in response codes.

returns esr-system-info

GET /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

Tags: ExternalSystem

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

200 OK

successful operation

/esr-system-info
default

Response codes found in response codes.

create or update an existing esr-system-info

PUT /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

Tags: ExternalSystem

create or update an existing esr-system-info

application/json application/xml

esr-system-info object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing esr-system-info

PATCH /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

Tags: ExternalSystem

update an existing esr-system-info

application/json application/xml

esr-system-info object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing esr-system-info

DELETE /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

Tags: ExternalSystem

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

Tags: ExternalSystem

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

Tags: ExternalSystem

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/relationship-list/relationship

Tags: ExternalSystem

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
thirdparty-sdnc-id

Unique ID of SDNC.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/relationship-list/relationship

Tags: ExternalSystem

delete an existing relationship

application/json application/xml

thirdparty-sdnc-id

Unique ID of SDNC.

 path string

application/json application/xml

default

Response codes found in response codes.

returns esr-vnfm-list

GET /external-system/esr-vnfm-list

Tags: ExternalSystem

returns esr-vnfm-list
vnfm-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

200 OK

successful operation

/esr-vnfm-list
default

Response codes found in response codes.

returns esr-vnfm

GET /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}

Tags: ExternalSystem

returns esr-vnfm
vnfm-id

Unique ID of VNFM.

 path string

application/json application/xml

200 OK

successful operation

/esr-vnfm
default

Response codes found in response codes.

create or update an existing esr-vnfm

PUT /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}

Tags: ExternalSystem

create or update an existing esr-vnfm

application/json application/xml

esr-vnfm object that needs to be created or updated.

/esr-vnfm
vnfm-id

Unique ID of VNFM.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing esr-vnfm

PATCH /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}

Tags: ExternalSystem

update an existing esr-vnfm

application/json application/xml

esr-vnfm object that needs to be updated.

/zzzz-patch-esr-vnfm
vnfm-id

Unique ID of VNFM.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing esr-vnfm

DELETE /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}

Tags: ExternalSystem

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

default

Response codes found in response codes.

returns esr-system-info-list

GET /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list

Tags: ExternalSystem

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/esr-system-info-list
default

Response codes found in response codes.

returns esr-system-info

GET /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

Tags: ExternalSystem

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

200 OK

successful operation

/esr-system-info
default

Response codes found in response codes.

create or update an existing esr-system-info

PUT /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

Tags: ExternalSystem

create or update an existing esr-system-info

application/json application/xml

esr-system-info object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing esr-system-info

PATCH /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

Tags: ExternalSystem

update an existing esr-system-info

application/json application/xml

esr-system-info object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing esr-system-info

DELETE /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

Tags: ExternalSystem

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

Tags: ExternalSystem

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
vnfm-id

Unique ID of VNFM.

 path string
esr-system-info-id

Unique ID of esr system info.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

Tags: ExternalSystem

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/relationship-list/relationship

Tags: ExternalSystem

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
vnfm-id

Unique ID of VNFM.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/relationship-list/relationship

Tags: ExternalSystem

delete an existing relationship

application/json application/xml

vnfm-id

Unique ID of VNFM.

 path string

application/json application/xml

default

Response codes found in response codes.

returns autonomous-systems

GET /network/autonomous-systems

Tags: Network

returns autonomous-systems
autonomous-system-id

n/a

 query string
autonomous-system-number

n/a

 query integer
autonomous-system-type

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

200 OK

successful operation

/autonomous-systems
default

Response codes found in response codes.

returns autonomous-system

GET /network/autonomous-systems/autonomous-system/{autonomous-system-id}

Tags: Network

returns autonomous-system
autonomous-system-id

UUID

 path string

application/json application/xml

200 OK

successful operation

/autonomous-system
default

Response codes found in response codes.

create or update an existing autonomous-system

PUT /network/autonomous-systems/autonomous-system/{autonomous-system-id}

Tags: Network

create or update an existing autonomous-system

application/json application/xml

autonomous-system object that needs to be created or updated.

/autonomous-system
autonomous-system-id

UUID

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing autonomous-system

PATCH /network/autonomous-systems/autonomous-system/{autonomous-system-id}

Tags: Network

update an existing autonomous-system

application/json application/xml

autonomous-system object that needs to be updated.

/zzzz-patch-autonomous-system
autonomous-system-id

UUID

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing autonomous-system

DELETE /network/autonomous-systems/autonomous-system/{autonomous-system-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/autonomous-systems/autonomous-system/{autonomous-system-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
autonomous-system-id

UUID

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/autonomous-systems/autonomous-system/{autonomous-system-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

autonomous-system-id

UUID

 path string

application/json application/xml

default

Response codes found in response codes.

returns bfds

GET /network/bfds

Tags: Network

returns bfds
bfd-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

200 OK

successful operation

/bfds
default

Response codes found in response codes.

returns bfd

GET /network/bfds/bfd/{bfd-id}

Tags: Network

returns bfd
bfd-id

Unique identifier.

 path string

application/json application/xml

200 OK

successful operation

/bfd
default

Response codes found in response codes.

create or update an existing bfd

PUT /network/bfds/bfd/{bfd-id}

Tags: Network

create or update an existing bfd

application/json application/xml

bfd object that needs to be created or updated.

/bfd
bfd-id

Unique identifier.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing bfd

PATCH /network/bfds/bfd/{bfd-id}

Tags: Network

update an existing bfd

application/json application/xml

bfd object that needs to be updated.

/zzzz-patch-bfd
bfd-id

Unique identifier.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing bfd

DELETE /network/bfds/bfd/{bfd-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/bfds/bfd/{bfd-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
bfd-id

Unique identifier.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/bfds/bfd/{bfd-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

bfd-id

Unique identifier.

 path string

application/json application/xml

default

Response codes found in response codes.

returns chassies

GET /network/chassies

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/chassies
default

Response codes found in response codes.

returns chassis

GET /network/chassies/chassis/{chassis-name}

Tags: Network

returns chassis
chassis-name

A globally unique name for the chassis.

 path string

application/json application/xml

200 OK

successful operation

/chassis
default

Response codes found in response codes.

create or update an existing chassis

PUT /network/chassies/chassis/{chassis-name}

Tags: Network

create or update an existing chassis

application/json application/xml

chassis object that needs to be created or updated.

/chassis
chassis-name

A globally unique name for the chassis.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing chassis

PATCH /network/chassies/chassis/{chassis-name}

Tags: Network

update an existing chassis

application/json application/xml

chassis object that needs to be updated.

/zzzz-patch-chassis
chassis-name

A globally unique name for the chassis.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing chassis

DELETE /network/chassies/chassis/{chassis-name}

Tags: Network

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

default

Response codes found in response codes.

returns card-slots

GET /network/chassies/chassis/{chassis-name}/card-slots

Tags: Network

returns card-slots
chassis-name

A globally unique name for the chassis.

 path string
slot-name

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

200 OK

successful operation

/card-slots
default

Response codes found in response codes.

returns card-slot

GET /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}

Tags: Network

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

200 OK

successful operation

/card-slot
default

Response codes found in response codes.

create or update an existing card-slot

PUT /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}

Tags: Network

create or update an existing card-slot

application/json application/xml

card-slot object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing card-slot

PATCH /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}

Tags: Network

update an existing card-slot

application/json application/xml

card-slot object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing card-slot

DELETE /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}

Tags: Network

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

default

Response codes found in response codes.

returns cards

GET /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/cards
default

Response codes found in response codes.

returns card

GET /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}

Tags: Network

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

200 OK

successful operation

/card
default

Response codes found in response codes.

create or update an existing card

PUT /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}

Tags: Network

create or update an existing card

application/json application/xml

card object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing card

PATCH /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}

Tags: Network

update an existing card

application/json application/xml

card object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing card

DELETE /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}

Tags: Network

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

default

Response codes found in response codes.

returns pluggable-slots

GET /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/pluggable-slots
default

Response codes found in response codes.

returns pluggable-slot

GET /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}

Tags: Network

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

200 OK

successful operation

/pluggable-slot
default

Response codes found in response codes.

create or update an existing pluggable-slot

PUT /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}

Tags: Network

create or update an existing pluggable-slot

application/json application/xml

pluggable-slot object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing pluggable-slot

PATCH /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}

Tags: Network

update an existing pluggable-slot

application/json application/xml

pluggable-slot object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing pluggable-slot

DELETE /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}

Tags: Network

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

default

Response codes found in response codes.

returns pluggables

GET /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}/pluggables

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/pluggables
default

Response codes found in response codes.

returns pluggable

GET /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}/pluggables/pluggable/{pluggable-type}

Tags: Network

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

200 OK

successful operation

/pluggable
default

Response codes found in response codes.

create or update an existing pluggable

PUT /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}/pluggables/pluggable/{pluggable-type}

Tags: Network

create or update an existing pluggable

application/json application/xml

pluggable object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing pluggable

PATCH /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}/pluggables/pluggable/{pluggable-type}

Tags: Network

update an existing pluggable

application/json application/xml

pluggable object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing pluggable

DELETE /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}/pluggables/pluggable/{pluggable-type}

Tags: Network

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

default

Response codes found in response codes.

returns ports

GET /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}/pluggables/pluggable/{pluggable-type}/ports

Tags: Network

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
equip-identifier

n/a

 query string
part-number

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

200 OK

successful operation

/ports
default

Response codes found in response codes.

returns port

GET /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}/pluggables/pluggable/{pluggable-type}/ports/port/{port-name}

Tags: Network

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

200 OK

successful operation

/port
default

Response codes found in response codes.

create or update an existing port

PUT /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}/pluggables/pluggable/{pluggable-type}/ports/port/{port-name}

Tags: Network

create or update an existing port

application/json application/xml

port object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing port

PATCH /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}/pluggables/pluggable/{pluggable-type}/ports/port/{port-name}

Tags: Network

update an existing port

application/json application/xml

port object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing port

DELETE /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}/pluggables/pluggable/{pluggable-type}/ports/port/{port-name}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}/pluggables/pluggable/{pluggable-type}/ports/port/{port-name}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}/pluggables/pluggable/{pluggable-type}/ports/port/{port-name}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}/pluggables/pluggable/{pluggable-type}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}/pluggables/pluggable/{pluggable-type}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/pluggable-slots/pluggable-slot/{pluggable-slot.slot-name}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns ports

GET /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/ports

Tags: Network

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
equip-identifier

n/a

 query string
part-number

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

200 OK

successful operation

/ports
default

Response codes found in response codes.

returns port

GET /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/ports/port/{port-name}

Tags: Network

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

200 OK

successful operation

/port
default

Response codes found in response codes.

create or update an existing port

PUT /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/ports/port/{port-name}

Tags: Network

create or update an existing port

application/json application/xml

port object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing port

PATCH /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/ports/port/{port-name}

Tags: Network

update an existing port

application/json application/xml

port object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing port

DELETE /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/ports/port/{port-name}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/ports/port/{port-name}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/ports/port/{port-name}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/cards/card/{card-type}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/chassies/chassis/{chassis-name}/card-slots/card-slot/{slot-name}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns licenses

GET /network/chassies/chassis/{chassis-name}/licenses

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/licenses
default

Response codes found in response codes.

returns license

GET /network/chassies/chassis/{chassis-name}/licenses/license/{group-uuid}/{resource-uuid}

Tags: Network

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

200 OK

successful operation

/license
default

Response codes found in response codes.

create or update an existing license

PUT /network/chassies/chassis/{chassis-name}/licenses/license/{group-uuid}/{resource-uuid}

Tags: Network

create or update an existing license

application/json application/xml

license object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing license

PATCH /network/chassies/chassis/{chassis-name}/licenses/license/{group-uuid}/{resource-uuid}

Tags: Network

update an existing license

application/json application/xml

license object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing license

DELETE /network/chassies/chassis/{chassis-name}/licenses/license/{group-uuid}/{resource-uuid}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/chassies/chassis/{chassis-name}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/chassies/chassis/{chassis-name}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns pluggable-slots

GET /network/chassies/chassis/{chassis-name}/pluggable-slots

Tags: Network

returns pluggable-slots
chassis-name

A globally unique name for the chassis.

 path string
slot-name

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

200 OK

successful operation

/pluggable-slots
default

Response codes found in response codes.

returns pluggable-slot

GET /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}

Tags: Network

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

200 OK

successful operation

/pluggable-slot
default

Response codes found in response codes.

create or update an existing pluggable-slot

PUT /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}

Tags: Network

create or update an existing pluggable-slot

application/json application/xml

pluggable-slot object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing pluggable-slot

PATCH /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}

Tags: Network

update an existing pluggable-slot

application/json application/xml

pluggable-slot object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing pluggable-slot

DELETE /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}

Tags: Network

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

default

Response codes found in response codes.

returns pluggables

GET /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}/pluggables

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/pluggables
default

Response codes found in response codes.

returns pluggable

GET /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}/pluggables/pluggable/{pluggable-type}

Tags: Network

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

200 OK

successful operation

/pluggable
default

Response codes found in response codes.

create or update an existing pluggable

PUT /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}/pluggables/pluggable/{pluggable-type}

Tags: Network

create or update an existing pluggable

application/json application/xml

pluggable object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing pluggable

PATCH /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}/pluggables/pluggable/{pluggable-type}

Tags: Network

update an existing pluggable

application/json application/xml

pluggable object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing pluggable

DELETE /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}/pluggables/pluggable/{pluggable-type}

Tags: Network

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

default

Response codes found in response codes.

returns ports

GET /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}/pluggables/pluggable/{pluggable-type}/ports

Tags: Network

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
equip-identifier

n/a

 query string
part-number

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

200 OK

successful operation

/ports
default

Response codes found in response codes.

returns port

GET /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}/pluggables/pluggable/{pluggable-type}/ports/port/{port-name}

Tags: Network

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

200 OK

successful operation

/port
default

Response codes found in response codes.

create or update an existing port

PUT /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}/pluggables/pluggable/{pluggable-type}/ports/port/{port-name}

Tags: Network

create or update an existing port

application/json application/xml

port object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing port

PATCH /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}/pluggables/pluggable/{pluggable-type}/ports/port/{port-name}

Tags: Network

update an existing port

application/json application/xml

port object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing port

DELETE /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}/pluggables/pluggable/{pluggable-type}/ports/port/{port-name}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}/pluggables/pluggable/{pluggable-type}/ports/port/{port-name}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}/pluggables/pluggable/{pluggable-type}/ports/port/{port-name}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}/pluggables/pluggable/{pluggable-type}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}/pluggables/pluggable/{pluggable-type}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/chassies/chassis/{chassis-name}/pluggable-slots/pluggable-slot/{slot-name}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns ports

GET /network/chassies/chassis/{chassis-name}/ports

Tags: Network

returns ports
chassis-name

A globally unique name for the chassis.

 path string
port-name

n/a

 query string
equip-identifier

n/a

 query string
part-number

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

200 OK

successful operation

/ports
default

Response codes found in response codes.

returns port

GET /network/chassies/chassis/{chassis-name}/ports/port/{port-name}

Tags: Network

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

200 OK

successful operation

/port
default

Response codes found in response codes.

create or update an existing port

PUT /network/chassies/chassis/{chassis-name}/ports/port/{port-name}

Tags: Network

create or update an existing port

application/json application/xml

port object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing port

PATCH /network/chassies/chassis/{chassis-name}/ports/port/{port-name}

Tags: Network

update an existing port

application/json application/xml

port object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing port

DELETE /network/chassies/chassis/{chassis-name}/ports/port/{port-name}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/chassies/chassis/{chassis-name}/ports/port/{port-name}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/chassies/chassis/{chassis-name}/ports/port/{port-name}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/chassies/chassis/{chassis-name}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
chassis-name

A globally unique name for the chassis.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/chassies/chassis/{chassis-name}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

chassis-name

A globally unique name for the chassis.

 path string

application/json application/xml

default

Response codes found in response codes.

returns collections

GET /network/collections

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/collections
default

Response codes found in response codes.

returns collection

GET /network/collections/collection/{collection-id}

Tags: Network

returns collection
collection-id

Collection Object UUID

 path string

application/json application/xml

200 OK

successful operation

/collection
default

Response codes found in response codes.

create or update an existing collection

PUT /network/collections/collection/{collection-id}

Tags: Network

create or update an existing collection

application/json application/xml

collection object that needs to be created or updated.

/collection
collection-id

Collection Object UUID

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing collection

PATCH /network/collections/collection/{collection-id}

Tags: Network

update an existing collection

application/json application/xml

collection object that needs to be updated.

/zzzz-patch-collection
collection-id

Collection Object UUID

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing collection

DELETE /network/collections/collection/{collection-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/collections/collection/{collection-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
collection-id

Collection Object UUID

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/collections/collection/{collection-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

collection-id

Collection Object UUID

 path string

application/json application/xml

default

Response codes found in response codes.

returns configurations

GET /network/configurations

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/configurations
default

Response codes found in response codes.

returns configuration

GET /network/configurations/configuration/{configuration-id}

Tags: Network

returns configuration
configuration-id

UUID assigned to configuration.

 path string

application/json application/xml

200 OK

successful operation

/configuration
default

Response codes found in response codes.

create or update an existing configuration

PUT /network/configurations/configuration/{configuration-id}

Tags: Network

create or update an existing configuration

application/json application/xml

configuration object that needs to be created or updated.

/configuration
configuration-id

UUID assigned to configuration.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing configuration

PATCH /network/configurations/configuration/{configuration-id}

Tags: Network

update an existing configuration

application/json application/xml

configuration object that needs to be updated.

/zzzz-patch-configuration
configuration-id

UUID assigned to configuration.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing configuration

DELETE /network/configurations/configuration/{configuration-id}

Tags: Network

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

default

Response codes found in response codes.

returns evcs

GET /network/configurations/configuration/{configuration-id}/evcs

Tags: Network

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

200 OK

successful operation

/evcs
default

Response codes found in response codes.

returns evc

GET /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}

Tags: Network

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

200 OK

successful operation

/evc
default

Response codes found in response codes.

create or update an existing evc

PUT /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}

Tags: Network

create or update an existing evc

application/json application/xml

evc object that needs to be created or updated.

/evc
configuration-id

UUID assigned to configuration.

 path string
evc-id

Unique/key field for the evc object

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing evc

PATCH /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}

Tags: Network

update an existing evc

application/json application/xml

evc object that needs to be updated.

/zzzz-patch-evc
configuration-id

UUID assigned to configuration.

 path string
evc-id

Unique/key field for the evc object

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing evc

DELETE /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
configuration-id

UUID assigned to configuration.

 path string
evc-id

Unique/key field for the evc object

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns forwarder-evcs

GET /network/configurations/configuration/{configuration-id}/forwarder-evcs

Tags: Network

returns forwarder-evcs
configuration-id

UUID assigned to configuration.

 path string
circuit-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

200 OK

successful operation

/forwarder-evcs
default

Response codes found in response codes.

returns forwarder-evc

GET /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}

Tags: Network

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

200 OK

successful operation

/forwarder-evc
default

Response codes found in response codes.

create or update an existing forwarder-evc

PUT /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}

Tags: Network

create or update an existing forwarder-evc

application/json application/xml

forwarder-evc object that needs to be created or updated.

/forwarder-evc
configuration-id

UUID assigned to configuration.

 path string
forwarder-evc-id

Key for forwarder-evc object

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing forwarder-evc

PATCH /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}

Tags: Network

update an existing forwarder-evc

application/json application/xml

forwarder-evc object that needs to be updated.

/zzzz-patch-forwarder-evc
configuration-id

UUID assigned to configuration.

 path string
forwarder-evc-id

Key for forwarder-evc object

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing forwarder-evc

DELETE /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
configuration-id

UUID assigned to configuration.

 path string
forwarder-evc-id

Key for forwarder-evc object

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns vlan-mappings

GET /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/vlan-mappings

Tags: Network

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

200 OK

successful operation

/vlan-mappings
default

Response codes found in response codes.

returns vlan-mapping

GET /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/vlan-mappings/vlan-mapping/{vlan-mapping-id}

Tags: Network

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

200 OK

successful operation

/vlan-mapping
default

Response codes found in response codes.

create or update an existing vlan-mapping

PUT /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/vlan-mappings/vlan-mapping/{vlan-mapping-id}

Tags: Network

create or update an existing vlan-mapping

application/json application/xml

vlan-mapping object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing vlan-mapping

PATCH /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/vlan-mappings/vlan-mapping/{vlan-mapping-id}

Tags: Network

update an existing vlan-mapping

application/json application/xml

vlan-mapping object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing vlan-mapping

DELETE /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/vlan-mappings/vlan-mapping/{vlan-mapping-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/vlan-mappings/vlan-mapping/{vlan-mapping-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/vlan-mappings/vlan-mapping/{vlan-mapping-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns metadata

GET /network/configurations/configuration/{configuration-id}/metadata

Tags: Network

returns metadata
configuration-id

UUID assigned to configuration.

 path string
metaname

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

200 OK

successful operation

/metadata
default

Response codes found in response codes.

returns metadatum

GET /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}

Tags: Network

returns metadatum
configuration-id

UUID assigned to configuration.

 path string
metaname path string

application/json application/xml

200 OK

successful operation

/metadatum
default

Response codes found in response codes.

create or update an existing metadatum

PUT /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}

Tags: Network

create or update an existing metadatum

application/json application/xml

metadatum object that needs to be created or updated.

/metadatum
configuration-id

UUID assigned to configuration.

 path string
metaname path string

application/json application/xml

default

Response codes found in response codes.

update an existing metadatum

PATCH /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}

Tags: Network

update an existing metadatum

application/json application/xml

metadatum object that needs to be updated.

/zzzz-patch-metadatum
configuration-id

UUID assigned to configuration.

 path string
metaname path string

application/json application/xml

default

Response codes found in response codes.

delete an existing metadatum

DELETE /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/configurations/configuration/{configuration-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
configuration-id

UUID assigned to configuration.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/configurations/configuration/{configuration-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

configuration-id

UUID assigned to configuration.

 path string

application/json application/xml

default

Response codes found in response codes.

returns connectivities

GET /network/connectivities

Tags: Network

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

200 OK

successful operation

/connectivities
default

Response codes found in response codes.

returns connectivity

GET /network/connectivities/connectivity/{connectivity-id}

Tags: Network

returns connectivity
connectivity-id

Uniquely identifies this connectivity by id

 path string

application/json application/xml

200 OK

successful operation

/connectivity
default

Response codes found in response codes.

create or update an existing connectivity

PUT /network/connectivities/connectivity/{connectivity-id}

Tags: Network

create or update an existing connectivity

application/json application/xml

connectivity object that needs to be created or updated.

/connectivity
connectivity-id

Uniquely identifies this connectivity by id

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing connectivity

PATCH /network/connectivities/connectivity/{connectivity-id}

Tags: Network

update an existing connectivity

application/json application/xml

connectivity object that needs to be updated.

/zzzz-patch-connectivity
connectivity-id

Uniquely identifies this connectivity by id

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing connectivity

DELETE /network/connectivities/connectivity/{connectivity-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/connectivities/connectivity/{connectivity-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
connectivity-id

Uniquely identifies this connectivity by id

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/connectivities/connectivity/{connectivity-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

connectivity-id

Uniquely identifies this connectivity by id

 path string

application/json application/xml

default

Response codes found in response codes.

returns devices

GET /network/devices

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/devices
default

Response codes found in response codes.

returns device

GET /network/devices/device/{device-id}

Tags: Network

returns device
device-id

Uniquely identifies this device by id

 path string

application/json application/xml

200 OK

successful operation

/device
default

Response codes found in response codes.

create or update an existing device

PUT /network/devices/device/{device-id}

Tags: Network

create or update an existing device

application/json application/xml

device object that needs to be created or updated.

/device
device-id

Uniquely identifies this device by id

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing device

PATCH /network/devices/device/{device-id}

Tags: Network

update an existing device

application/json application/xml

device object that needs to be updated.

/zzzz-patch-device
device-id

Uniquely identifies this device by id

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing device

DELETE /network/devices/device/{device-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/devices/device/{device-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
device-id

Uniquely identifies this device by id

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/devices/device/{device-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

device-id

Uniquely identifies this device by id

 path string

application/json application/xml

default

Response codes found in response codes.

returns ext-aai-networks

GET /network/ext-aai-networks

Tags: Network

returns ext-aai-networks
aai-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

200 OK

successful operation

/ext-aai-networks
default

Response codes found in response codes.

returns ext-aai-network

GET /network/ext-aai-networks/ext-aai-network/{aai-id}

Tags: Network

returns ext-aai-network
aai-id

Unique ID of the referenced AAI.

 path string

application/json application/xml

200 OK

successful operation

/ext-aai-network
default

Response codes found in response codes.

create or update an existing ext-aai-network

PUT /network/ext-aai-networks/ext-aai-network/{aai-id}

Tags: Network

create or update an existing ext-aai-network

application/json application/xml

ext-aai-network object that needs to be created or updated.

/ext-aai-network
aai-id

Unique ID of the referenced AAI.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing ext-aai-network

PATCH /network/ext-aai-networks/ext-aai-network/{aai-id}

Tags: Network

update an existing ext-aai-network

application/json application/xml

ext-aai-network object that needs to be updated.

/zzzz-patch-ext-aai-network
aai-id

Unique ID of the referenced AAI.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing ext-aai-network

DELETE /network/ext-aai-networks/ext-aai-network/{aai-id}

Tags: Network

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

default

Response codes found in response codes.

returns esr-system-info

GET /network/ext-aai-networks/ext-aai-network/{aai-id}/esr-system-info/{esr-system-info-id}

Tags: Network

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

200 OK

successful operation

/esr-system-info
default

Response codes found in response codes.

create or update an existing esr-system-info

PUT /network/ext-aai-networks/ext-aai-network/{aai-id}/esr-system-info/{esr-system-info-id}

Tags: Network

create or update an existing esr-system-info

application/json application/xml

esr-system-info object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing esr-system-info

PATCH /network/ext-aai-networks/ext-aai-network/{aai-id}/esr-system-info/{esr-system-info-id}

Tags: Network

update an existing esr-system-info

application/json application/xml

esr-system-info object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing esr-system-info

DELETE /network/ext-aai-networks/ext-aai-network/{aai-id}/esr-system-info/{esr-system-info-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/ext-aai-networks/ext-aai-network/{aai-id}/esr-system-info/{esr-system-info-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/ext-aai-networks/ext-aai-network/{aai-id}/esr-system-info/{esr-system-info-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/ext-aai-networks/ext-aai-network/{aai-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
aai-id

Unique ID of the referenced AAI.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/ext-aai-networks/ext-aai-network/{aai-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

aai-id

Unique ID of the referenced AAI.

 path string

application/json application/xml

default

Response codes found in response codes.

returns forwarding-paths

GET /network/forwarding-paths

Tags: Network

returns forwarding-paths
forwarding-path-id

n/a

 query string
forwarding-path-name

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

200 OK

successful operation

/forwarding-paths
default

Response codes found in response codes.

returns forwarding-path

GET /network/forwarding-paths/forwarding-path/{forwarding-path-id}

Tags: Network

returns forwarding-path
forwarding-path-id

Unique ID of this FP

 path string

application/json application/xml

200 OK

successful operation

/forwarding-path
default

Response codes found in response codes.

create or update an existing forwarding-path

PUT /network/forwarding-paths/forwarding-path/{forwarding-path-id}

Tags: Network

create or update an existing forwarding-path

application/json application/xml

forwarding-path object that needs to be created or updated.

/forwarding-path
forwarding-path-id

Unique ID of this FP

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing forwarding-path

PATCH /network/forwarding-paths/forwarding-path/{forwarding-path-id}

Tags: Network

update an existing forwarding-path

application/json application/xml

forwarding-path object that needs to be updated.

/zzzz-patch-forwarding-path
forwarding-path-id

Unique ID of this FP

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing forwarding-path

DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}

Tags: Network

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

default

Response codes found in response codes.

returns forwarders

GET /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders

Tags: Network

returns forwarders
forwarding-path-id

Unique ID of this FP

 path string
sequence

n/a

 query integer
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/forwarders
default

Response codes found in response codes.

returns forwarder

GET /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}

Tags: Network

returns forwarder
forwarding-path-id

Unique ID of this FP

 path string
sequence

Unique ID of this segmentation

 path integer

application/json application/xml

200 OK

successful operation

/forwarder
default

Response codes found in response codes.

create or update an existing forwarder

PUT /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}

Tags: Network

create or update an existing forwarder

application/json application/xml

forwarder object that needs to be created or updated.

/forwarder
forwarding-path-id

Unique ID of this FP

 path string
sequence

Unique ID of this segmentation

 path integer

application/json application/xml

default

Response codes found in response codes.

update an existing forwarder

PATCH /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}

Tags: Network

update an existing forwarder

application/json application/xml

forwarder object that needs to be updated.

/zzzz-patch-forwarder
forwarding-path-id

Unique ID of this FP

 path string
sequence

Unique ID of this segmentation

 path integer

application/json application/xml

default

Response codes found in response codes.

delete an existing forwarder

DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
forwarding-path-id

Unique ID of this FP

 path string
sequence

Unique ID of this segmentation

 path integer

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/forwarding-paths/forwarding-path/{forwarding-path-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
forwarding-path-id

Unique ID of this FP

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

forwarding-path-id

Unique ID of this FP

 path string

application/json application/xml

default

Response codes found in response codes.

returns fqdns

GET /network/fqdns

Tags: Network

returns fqdns
fqdn

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

200 OK

successful operation

/fqdns
default

Response codes found in response codes.

returns fqdn

GET /network/fqdns/fqdn/{fqdn}

Tags: Network

returns fqdn
fqdn

Fully qualified domain name.

 path string

application/json application/xml

200 OK

successful operation

/fqdn
default

Response codes found in response codes.

create or update an existing fqdn

PUT /network/fqdns/fqdn/{fqdn}

Tags: Network

create or update an existing fqdn

application/json application/xml

fqdn object that needs to be created or updated.

/fqdn
fqdn

Fully qualified domain name.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing fqdn

PATCH /network/fqdns/fqdn/{fqdn}

Tags: Network

update an existing fqdn

application/json application/xml

fqdn object that needs to be updated.

/zzzz-patch-fqdn
fqdn

Fully qualified domain name.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing fqdn

DELETE /network/fqdns/fqdn/{fqdn}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/fqdns/fqdn/{fqdn}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
fqdn

Fully qualified domain name.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/fqdns/fqdn/{fqdn}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

fqdn

Fully qualified domain name.

 path string

application/json application/xml

default

Response codes found in response codes.

returns generic-vnfs

GET /network/generic-vnfs

Tags: Network

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
vlan-id-outer

n/a

 query integer
nm-profile-name

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

200 OK

successful operation

/generic-vnfs
default

Response codes found in response codes.

returns generic-vnf

GET /network/generic-vnfs/generic-vnf/{vnf-id}

Tags: Network

returns generic-vnf
vnf-id

Unique id of VNF. This is unique across the graph.

 path string

application/json application/xml

200 OK

successful operation

/generic-vnf
default

Response codes found in response codes.

create or update an existing generic-vnf

PUT /network/generic-vnfs/generic-vnf/{vnf-id}

Tags: Network

create or update an existing generic-vnf

application/json application/xml

generic-vnf object that needs to be created or updated.

/generic-vnf
vnf-id

Unique id of VNF. This is unique across the graph.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing generic-vnf

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}

Tags: Network

update an existing generic-vnf

application/json application/xml

generic-vnf object that needs to be updated.

/zzzz-patch-generic-vnf
vnf-id

Unique id of VNF. This is unique across the graph.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing generic-vnf

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}

Tags: Network

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

default

Response codes found in response codes.

returns bgp-groups

GET /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-groups

Tags: Network

returns bgp-groups
vnf-id

Unique id of VNF. This is unique across the graph.

 path string
bgp-group-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

200 OK

successful operation

/bgp-groups
default

Response codes found in response codes.

returns bgp-group

GET /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-groups/bgp-group/{bgp-group-id}

Tags: Network

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

200 OK

successful operation

/bgp-group
default

Response codes found in response codes.

create or update an existing bgp-group

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-groups/bgp-group/{bgp-group-id}

Tags: Network

create or update an existing bgp-group

application/json application/xml

bgp-group object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing bgp-group

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-groups/bgp-group/{bgp-group-id}

Tags: Network

update an existing bgp-group

application/json application/xml

bgp-group object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing bgp-group

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-groups/bgp-group/{bgp-group-id}

Tags: Network

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

default

Response codes found in response codes.

returns address-families

GET /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-groups/bgp-group/{bgp-group-id}/address-families

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/address-families
default

Response codes found in response codes.

returns address-family

GET /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}

Tags: Network

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

200 OK

successful operation

/address-family
default

Response codes found in response codes.

create or update an existing address-family

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}

Tags: Network

create or update an existing address-family

application/json application/xml

address-family object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing address-family

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}

Tags: Network

update an existing address-family

application/json application/xml

address-family object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing address-family

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-groups/bgp-group/{bgp-group-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
vnf-id

Unique id of VNF. This is unique across the graph.

 path string
bgp-group-id

UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-groups/bgp-group/{bgp-group-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns bgp-neighbors

GET /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-neighbors

Tags: Network

returns bgp-neighbors
vnf-id

Unique id of VNF. This is unique across the graph.

 path string
bgp-neighbor-id

n/a

 query string
prov-status

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

200 OK

successful operation

/bgp-neighbors
default

Response codes found in response codes.

returns bgp-neighbor

GET /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

Tags: Network

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

200 OK

successful operation

/bgp-neighbor
default

Response codes found in response codes.

create or update an existing bgp-neighbor

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

Tags: Network

create or update an existing bgp-neighbor

application/json application/xml

bgp-neighbor object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing bgp-neighbor

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

Tags: Network

update an existing bgp-neighbor

application/json application/xml

bgp-neighbor object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing bgp-neighbor

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

Tags: Network

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

default

Response codes found in response codes.

returns address-families

GET /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/address-families
default

Response codes found in response codes.

returns address-family

GET /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

Tags: Network

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

200 OK

successful operation

/address-family
default

Response codes found in response codes.

create or update an existing address-family

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

Tags: Network

create or update an existing address-family

application/json application/xml

address-family object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing address-family

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

Tags: Network

update an existing address-family

application/json application/xml

address-family object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing address-family

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
vnf-id

Unique id of VNF. This is unique across the graph.

 path string
bgp-neighbor-id

UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns entitlements

GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/entitlements
default

Response codes found in response codes.

returns entitlement

GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

Tags: Network

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

200 OK

successful operation

/entitlement
default

Response codes found in response codes.

create or update an existing entitlement

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

Tags: Network

create or update an existing entitlement

application/json application/xml

entitlement object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing entitlement

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

Tags: Network

update an existing entitlement

application/json application/xml

entitlement object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing entitlement

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns l-interfaces

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/l-interfaces
default

Response codes found in response codes.

returns l-interface

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

Tags: Network

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

200 OK

successful operation

/l-interface
default

Response codes found in response codes.

create or update an existing l-interface

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

Tags: Network

create or update an existing l-interface

application/json application/xml

l-interface object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing l-interface

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

Tags: Network

update an existing l-interface

application/json application/xml

l-interface object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l-interface

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv4-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv4-address-list

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv4-address-list

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv4-address-list

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv6-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv6-address-list

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv6-address-list

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv6-address-list

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns lcmp-unreachables

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables

Tags: Network

returns lcmp-unreachables
vnf-id

Unique id of VNF. This is unique across the graph.

 path string
interface-name

Name given to the interface

 path string
lcmp-unreachable-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

200 OK

successful operation

/lcmp-unreachables
default

Response codes found in response codes.

returns lcmp-unreachable

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: Network

returns lcmp-unreachable
vnf-id

Unique id of VNF. This is unique across the graph.

 path string
interface-name

Name given to the interface

 path string
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

200 OK

successful operation

/lcmp-unreachable
default

Response codes found in response codes.

create or update an existing lcmp-unreachable

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: Network

create or update an existing lcmp-unreachable

application/json application/xml

lcmp-unreachable object that needs to be created or updated.

/lcmp-unreachable
vnf-id

Unique id of VNF. This is unique across the graph.

 path string
interface-name

Name given to the interface

 path string
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing lcmp-unreachable

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: Network

update an existing lcmp-unreachable

application/json application/xml

lcmp-unreachable object that needs to be updated.

/zzzz-patch-lcmp-unreachable
vnf-id

Unique id of VNF. This is unique across the graph.

 path string
interface-name

Name given to the interface

 path string
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing lcmp-unreachable

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: Network

delete an existing lcmp-unreachable

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
lcmp-unreachable-id

object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
vnf-id

Unique id of VNF. This is unique across the graph.

 path string
interface-name

Name given to the interface

 path string
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

Tags: Network

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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns sriov-vfs

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string
neutron-network-id

n/a

 query string

application/json application/xml

200 OK

successful operation

/sriov-vfs
default

Response codes found in response codes.

returns sriov-vf

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

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

200 OK

successful operation

/sriov-vf
default

Response codes found in response codes.

create or update an existing sriov-vf

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

create or update an existing sriov-vf

application/json application/xml

sriov-vf object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing sriov-vf

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

update an existing sriov-vf

application/json application/xml

sriov-vf object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing sriov-vf

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns temporary-parameter-lists

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists

Tags: Network

returns temporary-parameter-lists
vnf-id

Unique id of VNF. This is unique across the graph.

 path string
interface-name

Name given to the interface

 path string
temporary-parameter-list-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

200 OK

successful operation

/temporary-parameter-lists
default

Response codes found in response codes.

returns temporary-parameter-list

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

returns temporary-parameter-list
vnf-id

Unique id of VNF. This is unique across the graph.

 path string
interface-name

Name given to the interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

200 OK

successful operation

/temporary-parameter-list
default

Response codes found in response codes.

create or update an existing temporary-parameter-list

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

create or update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be created or updated.

/temporary-parameter-list
vnf-id

Unique id of VNF. This is unique across the graph.

 path string
interface-name

Name given to the interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing temporary-parameter-list

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be updated.

/zzzz-patch-temporary-parameter-list
vnf-id

Unique id of VNF. This is unique across the graph.

 path string
interface-name

Name given to the interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing temporary-parameter-list

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

delete an existing temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
vnf-id

Unique id of VNF. This is unique across the graph.

 path string
interface-name

Name given to the interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: Network

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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

returns vlans

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans

Tags: Network

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
vlan-id-outer

n/a

 query integer
vlan-type

n/a

 query string
vpn-key

n/a

 query string
orchestration-status

n/a

 query string
prov-status

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

200 OK

successful operation

/vlans
default

Response codes found in response codes.

returns vlan

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

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

200 OK

successful operation

/vlan
default

Response codes found in response codes.

create or update an existing vlan

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

create or update an existing vlan

application/json application/xml

vlan object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing vlan

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

update an existing vlan

application/json application/xml

vlan object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing vlan

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv4-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv4-address-list

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv4-address-list

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv4-address-list

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv6-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv6-address-list

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv6-address-list

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv6-address-list

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns lag-interfaces

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string
interface-type

n/a

 query string

application/json application/xml

200 OK

successful operation

/lag-interfaces
default

Response codes found in response codes.

returns lag-interface

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

Tags: Network

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

200 OK

successful operation

/lag-interface
default

Response codes found in response codes.

create or update an existing lag-interface

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

Tags: Network

create or update an existing lag-interface

application/json application/xml

lag-interface object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing lag-interface

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

Tags: Network

update an existing lag-interface

application/json application/xml

lag-interface object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing lag-interface

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

Tags: Network

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

default

Response codes found in response codes.

returns aggregated-ether-options

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options

Tags: Network

returns aggregated-ether-options
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
aggregated-ether-option-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

200 OK

successful operation

/aggregated-ether-options
default

Response codes found in response codes.

returns aggregated-ether-option

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}

Tags: Network

returns aggregated-ether-option
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
aggregated-ether-option-id

UUID - unique object identifier

 path string

application/json application/xml

200 OK

successful operation

/aggregated-ether-option
default

Response codes found in response codes.

create or update an existing aggregated-ether-option

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}

Tags: Network

create or update an existing aggregated-ether-option

application/json application/xml

aggregated-ether-option object that needs to be created or updated.

/aggregated-ether-option
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
aggregated-ether-option-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing aggregated-ether-option

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}

Tags: Network

update an existing aggregated-ether-option

application/json application/xml

aggregated-ether-option object that needs to be updated.

/zzzz-patch-aggregated-ether-option
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
aggregated-ether-option-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing aggregated-ether-option

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}

Tags: Network

delete an existing aggregated-ether-option

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
aggregated-ether-option-id

UUID - unique object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

returns lacps

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps

Tags: Network

returns lacps
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
aggregated-ether-option-id

UUID - unique object identifier

 path string
lacp-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

200 OK

successful operation

/lacps
default

Response codes found in response codes.

returns lacp

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}

Tags: Network

returns lacp
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
aggregated-ether-option-id

UUID - unique object identifier

 path string
lacp-id

UUID- unique object identifier

 path string

application/json application/xml

200 OK

successful operation

/lacp
default

Response codes found in response codes.

create or update an existing lacp

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}

Tags: Network

create or update an existing lacp

application/json application/xml

lacp object that needs to be created or updated.

/lacp
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
aggregated-ether-option-id

UUID - unique object identifier

 path string
lacp-id

UUID- unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing lacp

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}

Tags: Network

update an existing lacp

application/json application/xml

lacp object that needs to be updated.

/zzzz-patch-lacp
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
aggregated-ether-option-id

UUID - unique object identifier

 path string
lacp-id

UUID- unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing lacp

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}

Tags: Network

delete an existing lacp

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
aggregated-ether-option-id

UUID - unique object identifier

 path string
lacp-id

UUID- unique object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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
aggregated-ether-option-id

UUID - unique object identifier

 path string
lacp-id

UUID- unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}/relationship-list/relationship

Tags: Network

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
aggregated-ether-option-id

UUID - unique object identifier

 path string
lacp-id

UUID- unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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
aggregated-ether-option-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/relationship-list/relationship

Tags: Network

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
aggregated-ether-option-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

returns esis

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/esis

Tags: Network

returns esis
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
esi-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

200 OK

successful operation

/esis
default

Response codes found in response codes.

returns esi

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}

Tags: Network

returns esi
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
esi-id

object identifier

 path string

application/json application/xml

200 OK

successful operation

/esi
default

Response codes found in response codes.

create or update an existing esi

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}

Tags: Network

create or update an existing esi

application/json application/xml

esi object that needs to be created or updated.

/esi
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
esi-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing esi

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}

Tags: Network

update an existing esi

application/json application/xml

esi object that needs to be updated.

/zzzz-patch-esi
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
esi-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing esi

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}

Tags: Network

delete an existing esi

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
esi-id

object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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
esi-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}/relationship-list/relationship

Tags: Network

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
esi-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

returns l-interfaces

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/l-interfaces
default

Response codes found in response codes.

returns l-interface

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

Tags: Network

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

200 OK

successful operation

/l-interface
default

Response codes found in response codes.

create or update an existing l-interface

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

Tags: Network

create or update an existing l-interface

application/json application/xml

l-interface object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing l-interface

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

Tags: Network

update an existing l-interface

application/json application/xml

l-interface object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l-interface

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv4-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv4-address-list

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv4-address-list

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv4-address-list

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv6-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv6-address-list

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv6-address-list

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv6-address-list

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns lcmp-unreachables

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables

Tags: Network

returns lcmp-unreachables
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
lcmp-unreachable-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

200 OK

successful operation

/lcmp-unreachables
default

Response codes found in response codes.

returns lcmp-unreachable

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: Network

returns lcmp-unreachable
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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

200 OK

successful operation

/lcmp-unreachable
default

Response codes found in response codes.

create or update an existing lcmp-unreachable

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: Network

create or update an existing lcmp-unreachable

application/json application/xml

lcmp-unreachable object that needs to be created or updated.

/lcmp-unreachable
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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing lcmp-unreachable

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: Network

update an existing lcmp-unreachable

application/json application/xml

lcmp-unreachable object that needs to be updated.

/zzzz-patch-lcmp-unreachable
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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing lcmp-unreachable

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: Network

delete an existing lcmp-unreachable

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
lcmp-unreachable-id

object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

Tags: Network

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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns sriov-vfs

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string
neutron-network-id

n/a

 query string

application/json application/xml

200 OK

successful operation

/sriov-vfs
default

Response codes found in response codes.

returns sriov-vf

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

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

200 OK

successful operation

/sriov-vf
default

Response codes found in response codes.

create or update an existing sriov-vf

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

create or update an existing sriov-vf

application/json application/xml

sriov-vf object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing sriov-vf

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

update an existing sriov-vf

application/json application/xml

sriov-vf object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing sriov-vf

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns temporary-parameter-lists

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists

Tags: Network

returns temporary-parameter-lists
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
temporary-parameter-list-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

200 OK

successful operation

/temporary-parameter-lists
default

Response codes found in response codes.

returns temporary-parameter-list

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

returns temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

200 OK

successful operation

/temporary-parameter-list
default

Response codes found in response codes.

create or update an existing temporary-parameter-list

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

create or update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be created or updated.

/temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing temporary-parameter-list

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be updated.

/zzzz-patch-temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing temporary-parameter-list

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

delete an existing temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: Network

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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

returns vlans

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans

Tags: Network

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
vlan-id-outer

n/a

 query integer
vlan-type

n/a

 query string
vpn-key

n/a

 query string
orchestration-status

n/a

 query string
prov-status

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

200 OK

successful operation

/vlans
default

Response codes found in response codes.

returns vlan

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

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

200 OK

successful operation

/vlan
default

Response codes found in response codes.

create or update an existing vlan

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

create or update an existing vlan

application/json application/xml

vlan object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing vlan

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

update an existing vlan

application/json application/xml

vlan object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing vlan

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv4-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv4-address-list

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv4-address-list

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv4-address-list

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv6-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv6-address-list

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv6-address-list

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv6-address-list

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv4-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv4-address-list

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv4-address-list

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv4-address-list

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv6-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv6-address-list

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv6-address-list

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv6-address-list

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns temporary-parameter-lists

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists

Tags: Network

returns temporary-parameter-lists
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
temporary-parameter-list-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

200 OK

successful operation

/temporary-parameter-lists
default

Response codes found in response codes.

returns temporary-parameter-list

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

returns temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

200 OK

successful operation

/temporary-parameter-list
default

Response codes found in response codes.

create or update an existing temporary-parameter-list

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

create or update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be created or updated.

/temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing temporary-parameter-list

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be updated.

/zzzz-patch-temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing temporary-parameter-list

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

delete an existing temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: Network

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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

returns licenses

GET /network/generic-vnfs/generic-vnf/{vnf-id}/licenses

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/licenses
default

Response codes found in response codes.

returns license

GET /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

Tags: Network

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

200 OK

successful operation

/license
default

Response codes found in response codes.

create or update an existing license

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

Tags: Network

create or update an existing license

application/json application/xml

license object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing license

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

Tags: Network

update an existing license

application/json application/xml

license object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing license

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
vnf-id

Unique id of VNF. This is unique across the graph.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns vf-modules

GET /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/vf-modules
default

Response codes found in response codes.

returns vf-module

GET /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

Tags: Network

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

200 OK

successful operation

/vf-module
default

Response codes found in response codes.

create or update an existing vf-module

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

Tags: Network

create or update an existing vf-module

application/json application/xml

vf-module object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing vf-module

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

Tags: Network

update an existing vf-module

application/json application/xml

vf-module object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing vf-module

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns hw-components

GET /network/hw-components

Tags: Network

returns hw-components
hw-component-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

200 OK

successful operation

/hw-components
default

Response codes found in response codes.

returns hw-component

GET /network/hw-components/hw-component/{hw-component-id}

Tags: Network

returns hw-component
hw-component-id

UUID

 path string

application/json application/xml

200 OK

successful operation

/hw-component
default

Response codes found in response codes.

create or update an existing hw-component

PUT /network/hw-components/hw-component/{hw-component-id}

Tags: Network

create or update an existing hw-component

application/json application/xml

hw-component object that needs to be created or updated.

/hw-component
hw-component-id

UUID

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing hw-component

PATCH /network/hw-components/hw-component/{hw-component-id}

Tags: Network

update an existing hw-component

application/json application/xml

hw-component object that needs to be updated.

/zzzz-patch-hw-component
hw-component-id

UUID

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing hw-component

DELETE /network/hw-components/hw-component/{hw-component-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/hw-components/hw-component/{hw-component-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
hw-component-id

UUID

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/hw-components/hw-component/{hw-component-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

hw-component-id

UUID

 path string

application/json application/xml

default

Response codes found in response codes.

returns instance-groups

GET /network/instance-groups

Tags: Network

returns instance-groups
id

n/a

 query string
model-invariant-id

n/a

 query string
model-version-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

200 OK

successful operation

/instance-groups
default

Response codes found in response codes.

returns instance-group

GET /network/instance-groups/instance-group/{id}

Tags: Network

returns instance-group
id

Instance Group ID, UUID assigned to this instance.

 path string

application/json application/xml

200 OK

successful operation

/instance-group
default

Response codes found in response codes.

create or update an existing instance-group

PUT /network/instance-groups/instance-group/{id}

Tags: Network

create or update an existing instance-group

application/json application/xml

instance-group object that needs to be created or updated.

/instance-group
id

Instance Group ID, UUID assigned to this instance.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing instance-group

PATCH /network/instance-groups/instance-group/{id}

Tags: Network

update an existing instance-group

application/json application/xml

instance-group object that needs to be updated.

/zzzz-patch-instance-group
id

Instance Group ID, UUID assigned to this instance.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing instance-group

DELETE /network/instance-groups/instance-group/{id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/instance-groups/instance-group/{id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
id

Instance Group ID, UUID assigned to this instance.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/instance-groups/instance-group/{id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

id

Instance Group ID, UUID assigned to this instance.

 path string

application/json application/xml

default

Response codes found in response codes.

returns interlayer-attachments

GET /network/interlayer-attachments

Tags: Network

returns interlayer-attachments
id

n/a

 query string
model-invariant-id

n/a

 query string
model-version-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

200 OK

successful operation

/interlayer-attachments
default

Response codes found in response codes.

returns interlayer-attachment

GET /network/interlayer-attachments/interlayer-attachment/{id}

Tags: Network

returns interlayer-attachment
id

Id that identifies the interlayer topology attachment

 path string

application/json application/xml

200 OK

successful operation

/interlayer-attachment
default

Response codes found in response codes.

create or update an existing interlayer-attachment

PUT /network/interlayer-attachments/interlayer-attachment/{id}

Tags: Network

create or update an existing interlayer-attachment

application/json application/xml

interlayer-attachment object that needs to be created or updated.

/interlayer-attachment
id

Id that identifies the interlayer topology attachment

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing interlayer-attachment

PATCH /network/interlayer-attachments/interlayer-attachment/{id}

Tags: Network

update an existing interlayer-attachment

application/json application/xml

interlayer-attachment object that needs to be updated.

/zzzz-patch-interlayer-attachment
id

Id that identifies the interlayer topology attachment

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing interlayer-attachment

DELETE /network/interlayer-attachments/interlayer-attachment/{id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/interlayer-attachments/interlayer-attachment/{id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
id

Id that identifies the interlayer topology attachment

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/interlayer-attachments/interlayer-attachment/{id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

id

Id that identifies the interlayer topology attachment

 path string

application/json application/xml

default

Response codes found in response codes.

returns ipsec-configurations

GET /network/ipsec-configurations

Tags: Network

returns ipsec-configurations
ipsec-configuration-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

200 OK

successful operation

/ipsec-configurations
default

Response codes found in response codes.

returns ipsec-configuration

GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

Tags: Network

returns ipsec-configuration
ipsec-configuration-id

UUID of this configuration

 path string

application/json application/xml

200 OK

successful operation

/ipsec-configuration
default

Response codes found in response codes.

create or update an existing ipsec-configuration

PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

Tags: Network

create or update an existing ipsec-configuration

application/json application/xml

ipsec-configuration object that needs to be created or updated.

/ipsec-configuration
ipsec-configuration-id

UUID of this configuration

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing ipsec-configuration

PATCH /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

Tags: Network

update an existing ipsec-configuration

application/json application/xml

ipsec-configuration object that needs to be updated.

/zzzz-patch-ipsec-configuration
ipsec-configuration-id

UUID of this configuration

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing ipsec-configuration

DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
ipsec-configuration-id

UUID of this configuration

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

ipsec-configuration-id

UUID of this configuration

 path string

application/json application/xml

default

Response codes found in response codes.

returns vig-servers

GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers

Tags: Network

returns vig-servers
ipsec-configuration-id

UUID of this configuration

 path string
vig-address-type

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

200 OK

successful operation

/vig-servers
default

Response codes found in response codes.

returns vig-server

GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

Tags: Network

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

200 OK

successful operation

/vig-server
default

Response codes found in response codes.

create or update an existing vig-server

PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

Tags: Network

create or update an existing vig-server

application/json application/xml

vig-server object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing vig-server

PATCH /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

Tags: Network

update an existing vig-server

application/json application/xml

vig-server object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing vig-server

DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns l3-networks

GET /network/l3-networks

Tags: Network

returns l3-networks
network-id

n/a

 query string
network-name

n/a

 query string
network-role

n/a

 query string
neutron-network-id

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/l3-networks
default

Response codes found in response codes.

returns l3-network

GET /network/l3-networks/l3-network/{network-id}

Tags: Network

returns l3-network
network-id

Network ID, should be uuid. Unique across A&AI.

 path string

application/json application/xml

200 OK

successful operation

/l3-network
default

Response codes found in response codes.

create or update an existing l3-network

PUT /network/l3-networks/l3-network/{network-id}

Tags: Network

create or update an existing l3-network

application/json application/xml

l3-network object that needs to be created or updated.

/l3-network
network-id

Network ID, should be uuid. Unique across A&AI.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing l3-network

PATCH /network/l3-networks/l3-network/{network-id}

Tags: Network

update an existing l3-network

application/json application/xml

l3-network object that needs to be updated.

/zzzz-patch-l3-network
network-id

Network ID, should be uuid. Unique across A&AI.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing l3-network

DELETE /network/l3-networks/l3-network/{network-id}

Tags: Network

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

default

Response codes found in response codes.

returns aggregate-routes

GET /network/l3-networks/l3-network/{network-id}/aggregate-routes

Tags: Network

returns aggregate-routes
network-id

Network ID, should be uuid. Unique across A&AI.

 path string
agg-route-id

n/a

 query string
next-hop

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

200 OK

successful operation

/aggregate-routes
default

Response codes found in response codes.

returns aggregate-route

GET /network/l3-networks/l3-network/{network-id}/aggregate-routes/aggregate-route/{agg-route-id}

Tags: Network

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

200 OK

successful operation

/aggregate-route
default

Response codes found in response codes.

create or update an existing aggregate-route

PUT /network/l3-networks/l3-network/{network-id}/aggregate-routes/aggregate-route/{agg-route-id}

Tags: Network

create or update an existing aggregate-route

application/json application/xml

aggregate-route object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing aggregate-route

PATCH /network/l3-networks/l3-network/{network-id}/aggregate-routes/aggregate-route/{agg-route-id}

Tags: Network

update an existing aggregate-route

application/json application/xml

aggregate-route object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing aggregate-route

DELETE /network/l3-networks/l3-network/{network-id}/aggregate-routes/aggregate-route/{agg-route-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/l3-networks/l3-network/{network-id}/aggregate-routes/aggregate-route/{agg-route-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
network-id

Network ID, should be uuid. Unique across A&AI.

 path string
agg-route-id

Route UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/l3-networks/l3-network/{network-id}/aggregate-routes/aggregate-route/{agg-route-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns ctag-assignments

GET /network/l3-networks/l3-network/{network-id}/ctag-assignments

Tags: Network

returns ctag-assignments
network-id

Network ID, should be uuid. Unique across A&AI.

 path string
vlan-id-inner

n/a

 query integer
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/ctag-assignments
default

Response codes found in response codes.

returns ctag-assignment

GET /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

Tags: Network

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

200 OK

successful operation

/ctag-assignment
default

Response codes found in response codes.

create or update an existing ctag-assignment

PUT /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

Tags: Network

create or update an existing ctag-assignment

application/json application/xml

ctag-assignment object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing ctag-assignment

PATCH /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

Tags: Network

update an existing ctag-assignment

application/json application/xml

ctag-assignment object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing ctag-assignment

DELETE /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
network-id

Network ID, should be uuid. Unique across A&AI.

 path string
vlan-id-inner

id.

 path integer

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/l3-networks/l3-network/{network-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
network-id

Network ID, should be uuid. Unique across A&AI.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/l3-networks/l3-network/{network-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns segmentation-assignments

GET /network/l3-networks/l3-network/{network-id}/segmentation-assignments

Tags: Network

returns segmentation-assignments
network-id

Network ID, should be uuid. Unique across A&AI.

 path string
segmentation-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

200 OK

successful operation

/segmentation-assignments
default

Response codes found in response codes.

returns segmentation-assignment

GET /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

Tags: Network

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

200 OK

successful operation

/segmentation-assignment
default

Response codes found in response codes.

create or update an existing segmentation-assignment

PUT /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

Tags: Network

create or update an existing segmentation-assignment

application/json application/xml

segmentation-assignment object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing segmentation-assignment

PATCH /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

Tags: Network

update an existing segmentation-assignment

application/json application/xml

segmentation-assignment object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing segmentation-assignment

DELETE /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns subnets

GET /network/l3-networks/l3-network/{network-id}/subnets

Tags: Network

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
neutron-subnet-id

n/a

 query string
orchestration-status

n/a

 query string
subnet-type

n/a

 query string
subnet-function

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

200 OK

successful operation

/subnets
default

Response codes found in response codes.

returns subnet

GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

Tags: Network

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

200 OK

successful operation

/subnet
default

Response codes found in response codes.

create or update an existing subnet

PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

Tags: Network

create or update an existing subnet

application/json application/xml

subnet object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing subnet

PATCH /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

Tags: Network

update an existing subnet

application/json application/xml

subnet object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing subnet

DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

Tags: Network

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

default

Response codes found in response codes.

returns bgp-neighbors

GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/bgp-neighbors

Tags: Network

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
prov-status

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

200 OK

successful operation

/bgp-neighbors
default

Response codes found in response codes.

returns bgp-neighbor

GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

Tags: Network

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

200 OK

successful operation

/bgp-neighbor
default

Response codes found in response codes.

create or update an existing bgp-neighbor

PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

Tags: Network

create or update an existing bgp-neighbor

application/json application/xml

bgp-neighbor object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing bgp-neighbor

PATCH /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

Tags: Network

update an existing bgp-neighbor

application/json application/xml

bgp-neighbor object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing bgp-neighbor

DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

Tags: Network

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

default

Response codes found in response codes.

returns address-families

GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/address-families
default

Response codes found in response codes.

returns address-family

GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

Tags: Network

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

200 OK

successful operation

/address-family
default

Response codes found in response codes.

create or update an existing address-family

PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

Tags: Network

create or update an existing address-family

application/json application/xml

address-family object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing address-family

PATCH /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

Tags: Network

update an existing address-family

application/json application/xml

address-family object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing address-family

DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns host-routes

GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes

Tags: Network

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
next-hop

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

200 OK

successful operation

/host-routes
default

Response codes found in response codes.

returns host-route

GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

Tags: Network

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

200 OK

successful operation

/host-route
default

Response codes found in response codes.

create or update an existing host-route

PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

Tags: Network

create or update an existing host-route

application/json application/xml

host-route object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing host-route

PATCH /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

Tags: Network

update an existing host-route

application/json application/xml

host-route object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing host-route

DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns ip-address-list

GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/ip-address-list/{ip-address}

Tags: Network

returns ip-address-list
network-id

Network ID, should be uuid. Unique across A&AI.

 path string
subnet-id

Subnet ID, should be UUID.

 path string
ip-address

IP address

 path string

application/json application/xml

200 OK

successful operation

/ip-address-list
default

Response codes found in response codes.

create or update an existing ip-address-list

PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/ip-address-list/{ip-address}

Tags: Network

create or update an existing ip-address-list

application/json application/xml

ip-address-list object that needs to be created or updated.

/ip-address-list
network-id

Network ID, should be uuid. Unique across A&AI.

 path string
subnet-id

Subnet ID, should be UUID.

 path string
ip-address

IP address

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing ip-address-list

PATCH /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/ip-address-list/{ip-address}

Tags: Network

update an existing ip-address-list

application/json application/xml

ip-address-list object that needs to be updated.

/zzzz-patch-ip-address-list
network-id

Network ID, should be uuid. Unique across A&AI.

 path string
subnet-id

Subnet ID, should be UUID.

 path string
ip-address

IP address

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing ip-address-list

DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/ip-address-list/{ip-address}

Tags: Network

delete an existing ip-address-list

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
ip-address

IP address

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/ip-address-list/{ip-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
network-id

Network ID, should be uuid. Unique across A&AI.

 path string
subnet-id

Subnet ID, should be UUID.

 path string
ip-address

IP address

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/ip-address-list/{ip-address}/relationship-list/relationship

Tags: Network

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
ip-address

IP address

 path string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns label-restrictions

GET /network/label-restrictions

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/label-restrictions
default

Response codes found in response codes.

returns label-restriction

GET /network/label-restrictions/label-restriction/{id}

Tags: Network

returns label-restriction
id

Id that identifies the label restriction

 path string

application/json application/xml

200 OK

successful operation

/label-restriction
default

Response codes found in response codes.

create or update an existing label-restriction

PUT /network/label-restrictions/label-restriction/{id}

Tags: Network

create or update an existing label-restriction

application/json application/xml

label-restriction object that needs to be created or updated.

/label-restriction
id

Id that identifies the label restriction

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing label-restriction

PATCH /network/label-restrictions/label-restriction/{id}

Tags: Network

update an existing label-restriction

application/json application/xml

label-restriction object that needs to be updated.

/zzzz-patch-label-restriction
id

Id that identifies the label restriction

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing label-restriction

DELETE /network/label-restrictions/label-restriction/{id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/label-restrictions/label-restriction/{id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
id

Id that identifies the label restriction

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/label-restrictions/label-restriction/{id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

id

Id that identifies the label restriction

 path string

application/json application/xml

default

Response codes found in response codes.

returns lag-links

GET /network/lag-links

Tags: Network

returns lag-links
link-name

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

200 OK

successful operation

/lag-links
default

Response codes found in response codes.

returns lag-link

GET /network/lag-links/lag-link/{link-name}

Tags: Network

returns lag-link
link-name

Alphabetical concatenation of lag-interface names

 path string

application/json application/xml

200 OK

successful operation

/lag-link
default

Response codes found in response codes.

create or update an existing lag-link

PUT /network/lag-links/lag-link/{link-name}

Tags: Network

create or update an existing lag-link

application/json application/xml

lag-link object that needs to be created or updated.

/lag-link
link-name

Alphabetical concatenation of lag-interface names

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing lag-link

PATCH /network/lag-links/lag-link/{link-name}

Tags: Network

update an existing lag-link

application/json application/xml

lag-link object that needs to be updated.

/zzzz-patch-lag-link
link-name

Alphabetical concatenation of lag-interface names

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing lag-link

DELETE /network/lag-links/lag-link/{link-name}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/lag-links/lag-link/{link-name}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
link-name

Alphabetical concatenation of lag-interface names

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/lag-links/lag-link/{link-name}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

link-name

Alphabetical concatenation of lag-interface names

 path string

application/json application/xml

default

Response codes found in response codes.

returns lan-port-configs

GET /network/lan-port-configs

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/lan-port-configs
default

Response codes found in response codes.

returns lan-port-config

GET /network/lan-port-configs/lan-port-config/{lan-port-config-id}

Tags: Network

returns lan-port-config
lan-port-config-id

Uniquely identifies this lan-port-config by id

 path string

application/json application/xml

200 OK

successful operation

/lan-port-config
default

Response codes found in response codes.

create or update an existing lan-port-config

PUT /network/lan-port-configs/lan-port-config/{lan-port-config-id}

Tags: Network

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
lan-port-config-id

Uniquely identifies this lan-port-config by id

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing lan-port-config

PATCH /network/lan-port-configs/lan-port-config/{lan-port-config-id}

Tags: Network

update an existing lan-port-config

application/json application/xml

lan-port-config object that needs to be updated.

/zzzz-patch-lan-port-config
lan-port-config-id

Uniquely identifies this lan-port-config by id

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing lan-port-config

DELETE /network/lan-port-configs/lan-port-config/{lan-port-config-id}

Tags: Network

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

default

Response codes found in response codes.

returns dhcp-services

GET /network/lan-port-configs/lan-port-config/{lan-port-config-id}/dhcp-services

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/dhcp-services
default

Response codes found in response codes.

returns dhcp-service

GET /network/lan-port-configs/lan-port-config/{lan-port-config-id}/dhcp-services/dhcp-service/{dhcp-service-id}

Tags: Network

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

200 OK

successful operation

/dhcp-service
default

Response codes found in response codes.

create or update an existing dhcp-service

PUT /network/lan-port-configs/lan-port-config/{lan-port-config-id}/dhcp-services/dhcp-service/{dhcp-service-id}

Tags: Network

create or update an existing dhcp-service

application/json application/xml

dhcp-service object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing dhcp-service

PATCH /network/lan-port-configs/lan-port-config/{lan-port-config-id}/dhcp-services/dhcp-service/{dhcp-service-id}

Tags: Network

update an existing dhcp-service

application/json application/xml

dhcp-service object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing dhcp-service

DELETE /network/lan-port-configs/lan-port-config/{lan-port-config-id}/dhcp-services/dhcp-service/{dhcp-service-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/lan-port-configs/lan-port-config/{lan-port-config-id}/dhcp-services/dhcp-service/{dhcp-service-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/lan-port-configs/lan-port-config/{lan-port-config-id}/dhcp-services/dhcp-service/{dhcp-service-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/lan-port-configs/lan-port-config/{lan-port-config-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
lan-port-config-id

Uniquely identifies this lan-port-config by id

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/lan-port-configs/lan-port-config/{lan-port-config-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns logical-links

GET /network/logical-links

Tags: Network

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-role

n/a

 query string
link-id

n/a

 query string
circuit-id

n/a

 query string
purpose

n/a

 query string
link-description

n/a

 query string
link-function

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

200 OK

successful operation

/logical-links
default

Response codes found in response codes.

returns logical-link

GET /network/logical-links/logical-link/{link-name}

Tags: Network

returns logical-link
link-name

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

 path string

application/json application/xml

200 OK

successful operation

/logical-link
default

Response codes found in response codes.

create or update an existing logical-link

PUT /network/logical-links/logical-link/{link-name}

Tags: Network

create or update an existing logical-link

application/json application/xml

logical-link object that needs to be created or updated.

/logical-link
link-name

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing logical-link

PATCH /network/logical-links/logical-link/{link-name}

Tags: Network

update an existing logical-link

application/json application/xml

logical-link object that needs to be updated.

/zzzz-patch-logical-link
link-name

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing logical-link

DELETE /network/logical-links/logical-link/{link-name}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/logical-links/logical-link/{link-name}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
link-name

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/logical-links/logical-link/{link-name}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns mappings

GET /network/mappings

Tags: Network

returns mappings
mapping-id

n/a

 query string
prov-status

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

200 OK

successful operation

/mappings
default

Response codes found in response codes.

returns mapping

GET /network/mappings/mapping/{mapping-id}

Tags: Network

returns mapping
mapping-id

Key for mapping object.

 path string

application/json application/xml

200 OK

successful operation

/mapping
default

Response codes found in response codes.

create or update an existing mapping

PUT /network/mappings/mapping/{mapping-id}

Tags: Network

create or update an existing mapping

application/json application/xml

mapping object that needs to be created or updated.

/mapping
mapping-id

Key for mapping object.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing mapping

PATCH /network/mappings/mapping/{mapping-id}

Tags: Network

update an existing mapping

application/json application/xml

mapping object that needs to be updated.

/zzzz-patch-mapping
mapping-id

Key for mapping object.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing mapping

DELETE /network/mappings/mapping/{mapping-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/mappings/mapping/{mapping-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
mapping-id

Key for mapping object.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/mappings/mapping/{mapping-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

mapping-id

Key for mapping object.

 path string

application/json application/xml

default

Response codes found in response codes.

returns multicast-configurations

GET /network/multicast-configurations

Tags: Network

returns multicast-configurations
multicast-configuration-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

200 OK

successful operation

/multicast-configurations
default

Response codes found in response codes.

returns multicast-configuration

GET /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

Tags: Network

returns multicast-configuration
multicast-configuration-id

Unique id of multicast configuration.

 path string

application/json application/xml

200 OK

successful operation

/multicast-configuration
default

Response codes found in response codes.

create or update an existing multicast-configuration

PUT /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

Tags: Network

create or update an existing multicast-configuration

application/json application/xml

multicast-configuration object that needs to be created or updated.

/multicast-configuration
multicast-configuration-id

Unique id of multicast configuration.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing multicast-configuration

PATCH /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

Tags: Network

update an existing multicast-configuration

application/json application/xml

multicast-configuration object that needs to be updated.

/zzzz-patch-multicast-configuration
multicast-configuration-id

Unique id of multicast configuration.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing multicast-configuration

DELETE /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
multicast-configuration-id

Unique id of multicast configuration.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

multicast-configuration-id

Unique id of multicast configuration.

 path string

application/json application/xml

default

Response codes found in response codes.

returns network-policies

GET /network/network-policies

Tags: Network

returns network-policies
network-policy-id

n/a

 query string
network-policy-fqdn

n/a

 query string
heat-stack-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

200 OK

successful operation

/network-policies
default

Response codes found in response codes.

returns network-policy

GET /network/network-policies/network-policy/{network-policy-id}

Tags: Network

returns network-policy
network-policy-id

UUID representing unique key to this instance

 path string

application/json application/xml

200 OK

successful operation

/network-policy
default

Response codes found in response codes.

create or update an existing network-policy

PUT /network/network-policies/network-policy/{network-policy-id}

Tags: Network

create or update an existing network-policy

application/json application/xml

network-policy object that needs to be created or updated.

/network-policy
network-policy-id

UUID representing unique key to this instance

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing network-policy

PATCH /network/network-policies/network-policy/{network-policy-id}

Tags: Network

update an existing network-policy

application/json application/xml

network-policy object that needs to be updated.

/zzzz-patch-network-policy
network-policy-id

UUID representing unique key to this instance

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing network-policy

DELETE /network/network-policies/network-policy/{network-policy-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
network-policy-id

UUID representing unique key to this instance

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

network-policy-id

UUID representing unique key to this instance

 path string

application/json application/xml

default

Response codes found in response codes.

returns network-ranges

GET /network/network-ranges

Tags: Network

returns network-ranges
network-range-id

n/a

 query string
network-range-name

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

200 OK

successful operation

/network-ranges
default

Response codes found in response codes.

returns network-range

GET /network/network-ranges/network-range/{network-range-id}

Tags: Network

returns network-range
network-range-id

UUID

 path string

application/json application/xml

200 OK

successful operation

/network-range
default

Response codes found in response codes.

create or update an existing network-range

PUT /network/network-ranges/network-range/{network-range-id}

Tags: Network

create or update an existing network-range

application/json application/xml

network-range object that needs to be created or updated.

/network-range
network-range-id

UUID

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing network-range

PATCH /network/network-ranges/network-range/{network-range-id}

Tags: Network

update an existing network-range

application/json application/xml

network-range object that needs to be updated.

/zzzz-patch-network-range
network-range-id

UUID

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing network-range

DELETE /network/network-ranges/network-range/{network-range-id}

Tags: Network

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

default

Response codes found in response codes.

returns activities

GET /network/network-ranges/network-range/{network-range-id}/activities

Tags: Network

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

200 OK

successful operation

/activities
default

Response codes found in response codes.

returns activity

GET /network/network-ranges/network-range/{network-range-id}/activities/activity/{activity-id}

Tags: Network

returns activity
network-range-id

UUID

 path string
activity-id

Unique id for the activity. (UUID)

 path string

application/json application/xml

200 OK

successful operation

/activity
default

Response codes found in response codes.

create or update an existing activity

PUT /network/network-ranges/network-range/{network-range-id}/activities/activity/{activity-id}

Tags: Network

create or update an existing activity

application/json application/xml

activity object that needs to be created or updated.

/activity
network-range-id

UUID

 path string
activity-id

Unique id for the activity. (UUID)

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing activity

PATCH /network/network-ranges/network-range/{network-range-id}/activities/activity/{activity-id}

Tags: Network

update an existing activity

application/json application/xml

activity object that needs to be updated.

/zzzz-patch-activity
network-range-id

UUID

 path string
activity-id

Unique id for the activity. (UUID)

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing activity

DELETE /network/network-ranges/network-range/{network-range-id}/activities/activity/{activity-id}

Tags: Network

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

default

Response codes found in response codes.

returns activity-states

GET /network/network-ranges/network-range/{network-range-id}/activities/activity/{activity-id}/activity-states

Tags: Network

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

200 OK

successful operation

/activity-states
default

Response codes found in response codes.

returns activity-state

GET /network/network-ranges/network-range/{network-range-id}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

Tags: Network

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

200 OK

successful operation

/activity-state
default

Response codes found in response codes.

create or update an existing activity-state

PUT /network/network-ranges/network-range/{network-range-id}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

Tags: Network

create or update an existing activity-state

application/json application/xml

activity-state object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing activity-state

PATCH /network/network-ranges/network-range/{network-range-id}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

Tags: Network

update an existing activity-state

application/json application/xml

activity-state object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing activity-state

DELETE /network/network-ranges/network-range/{network-range-id}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/network-ranges/network-range/{network-range-id}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/network-ranges/network-range/{network-range-id}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/network-ranges/network-range/{network-range-id}/activities/activity/{activity-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
network-range-id

UUID

 path string
activity-id

Unique id for the activity. (UUID)

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/network-ranges/network-range/{network-range-id}/activities/activity/{activity-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/network-ranges/network-range/{network-range-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
network-range-id

UUID

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/network-ranges/network-range/{network-range-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

network-range-id

UUID

 path string

application/json application/xml

default

Response codes found in response codes.

returns network-resources

GET /network/network-resources

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/network-resources
default

Response codes found in response codes.

returns network-resource

GET /network/network-resources/network-resource/{network-id}

Tags: Network

returns network-resource
network-id

Uniquely identifies this network-resource by id

 path string

application/json application/xml

200 OK

successful operation

/network-resource
default

Response codes found in response codes.

create or update an existing network-resource

PUT /network/network-resources/network-resource/{network-id}

Tags: Network

create or update an existing network-resource

application/json application/xml

network-resource object that needs to be created or updated.

/network-resource
network-id

Uniquely identifies this network-resource by id

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing network-resource

PATCH /network/network-resources/network-resource/{network-id}

Tags: Network

update an existing network-resource

application/json application/xml

network-resource object that needs to be updated.

/zzzz-patch-network-resource
network-id

Uniquely identifies this network-resource by id

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing network-resource

DELETE /network/network-resources/network-resource/{network-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/network-resources/network-resource/{network-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
network-id

Uniquely identifies this network-resource by id

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/network-resources/network-resource/{network-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

network-id

Uniquely identifies this network-resource by id

 path string

application/json application/xml

default

Response codes found in response codes.

returns network-routes

GET /network/network-routes

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/network-routes
default

Response codes found in response codes.

returns network-route

GET /network/network-routes/network-route/{route-id}

Tags: Network

returns network-route
route-id

unique identifier example uuid.

 path string

application/json application/xml

200 OK

successful operation

/network-route
default

Response codes found in response codes.

create or update an existing network-route

PUT /network/network-routes/network-route/{route-id}

Tags: Network

create or update an existing network-route

application/json application/xml

network-route object that needs to be created or updated.

/network-route
route-id

unique identifier example uuid.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing network-route

PATCH /network/network-routes/network-route/{route-id}

Tags: Network

update an existing network-route

application/json application/xml

network-route object that needs to be updated.

/zzzz-patch-network-route
route-id

unique identifier example uuid.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing network-route

DELETE /network/network-routes/network-route/{route-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/network-routes/network-route/{route-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
route-id

unique identifier example uuid.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/network-routes/network-route/{route-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

route-id

unique identifier example uuid.

 path string

application/json application/xml

default

Response codes found in response codes.

returns newvces

GET /network/newvces

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/newvces
default

Response codes found in response codes.

returns newvce

GET /network/newvces/newvce/{vnf-id2}

Tags: Network

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

200 OK

successful operation

/newvce
default

Response codes found in response codes.

create or update an existing newvce

PUT /network/newvces/newvce/{vnf-id2}

Tags: Network

create or update an existing newvce

application/json application/xml

newvce object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing newvce

PATCH /network/newvces/newvce/{vnf-id2}

Tags: Network

update an existing newvce

application/json application/xml

newvce object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing newvce

DELETE /network/newvces/newvce/{vnf-id2}

Tags: Network

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

default

Response codes found in response codes.

returns l-interfaces

GET /network/newvces/newvce/{vnf-id2}/l-interfaces

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/l-interfaces
default

Response codes found in response codes.

returns l-interface

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

Tags: Network

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

200 OK

successful operation

/l-interface
default

Response codes found in response codes.

create or update an existing l-interface

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

Tags: Network

create or update an existing l-interface

application/json application/xml

l-interface object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing l-interface

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

Tags: Network

update an existing l-interface

application/json application/xml

l-interface object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l-interface

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv4-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv4-address-list

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv4-address-list

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv4-address-list

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv6-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv6-address-list

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv6-address-list

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv6-address-list

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns lcmp-unreachables

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables

Tags: Network

returns lcmp-unreachables
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
lcmp-unreachable-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

200 OK

successful operation

/lcmp-unreachables
default

Response codes found in response codes.

returns lcmp-unreachable

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: Network

returns lcmp-unreachable
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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

200 OK

successful operation

/lcmp-unreachable
default

Response codes found in response codes.

create or update an existing lcmp-unreachable

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: Network

create or update an existing lcmp-unreachable

application/json application/xml

lcmp-unreachable object that needs to be created or updated.

/lcmp-unreachable
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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing lcmp-unreachable

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: Network

update an existing lcmp-unreachable

application/json application/xml

lcmp-unreachable object that needs to be updated.

/zzzz-patch-lcmp-unreachable
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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing lcmp-unreachable

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: Network

delete an existing lcmp-unreachable

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
lcmp-unreachable-id

object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

Tags: Network

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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns sriov-vfs

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string
neutron-network-id

n/a

 query string

application/json application/xml

200 OK

successful operation

/sriov-vfs
default

Response codes found in response codes.

returns sriov-vf

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

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

200 OK

successful operation

/sriov-vf
default

Response codes found in response codes.

create or update an existing sriov-vf

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

create or update an existing sriov-vf

application/json application/xml

sriov-vf object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing sriov-vf

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

update an existing sriov-vf

application/json application/xml

sriov-vf object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing sriov-vf

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns temporary-parameter-lists

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists

Tags: Network

returns temporary-parameter-lists
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
temporary-parameter-list-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

200 OK

successful operation

/temporary-parameter-lists
default

Response codes found in response codes.

returns temporary-parameter-list

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

returns temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

200 OK

successful operation

/temporary-parameter-list
default

Response codes found in response codes.

create or update an existing temporary-parameter-list

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

create or update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be created or updated.

/temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing temporary-parameter-list

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be updated.

/zzzz-patch-temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing temporary-parameter-list

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

delete an existing temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: Network

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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

returns vlans

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans

Tags: Network

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
vlan-id-outer

n/a

 query integer
vlan-type

n/a

 query string
vpn-key

n/a

 query string
orchestration-status

n/a

 query string
prov-status

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

200 OK

successful operation

/vlans
default

Response codes found in response codes.

returns vlan

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

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

200 OK

successful operation

/vlan
default

Response codes found in response codes.

create or update an existing vlan

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

create or update an existing vlan

application/json application/xml

vlan object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing vlan

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

update an existing vlan

application/json application/xml

vlan object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing vlan

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv4-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv4-address-list

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv4-address-list

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv4-address-list

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv6-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv6-address-list

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv6-address-list

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv6-address-list

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/newvces/newvce/{vnf-id2}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/newvces/newvce/{vnf-id2}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns next-hops

GET /network/next-hops

Tags: Network

returns next-hops
next-hop-id

n/a

 query string
sequence

n/a

 query integer
ip-address

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

200 OK

successful operation

/next-hops
default

Response codes found in response codes.

returns next-hop

GET /network/next-hops/next-hop/{next-hop-id}

Tags: Network

returns next-hop
next-hop-id

UUID.

 path string

application/json application/xml

200 OK

successful operation

/next-hop
default

Response codes found in response codes.

create or update an existing next-hop

PUT /network/next-hops/next-hop/{next-hop-id}

Tags: Network

create or update an existing next-hop

application/json application/xml

next-hop object that needs to be created or updated.

/next-hop
next-hop-id

UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing next-hop

PATCH /network/next-hops/next-hop/{next-hop-id}

Tags: Network

update an existing next-hop

application/json application/xml

next-hop object that needs to be updated.

/zzzz-patch-next-hop
next-hop-id

UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing next-hop

DELETE /network/next-hops/next-hop/{next-hop-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/next-hops/next-hop/{next-hop-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
next-hop-id

UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/next-hops/next-hop/{next-hop-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

next-hop-id

UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

returns physical-links

GET /network/physical-links

Tags: Network

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
link-description

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

200 OK

successful operation

/physical-links
default

Response codes found in response codes.

returns physical-link

GET /network/physical-links/physical-link/{link-name}

Tags: Network

returns physical-link
link-name

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

 path string

application/json application/xml

200 OK

successful operation

/physical-link
default

Response codes found in response codes.

create or update an existing physical-link

PUT /network/physical-links/physical-link/{link-name}

Tags: Network

create or update an existing physical-link

application/json application/xml

physical-link object that needs to be created or updated.

/physical-link
link-name

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing physical-link

PATCH /network/physical-links/physical-link/{link-name}

Tags: Network

update an existing physical-link

application/json application/xml

physical-link object that needs to be updated.

/zzzz-patch-physical-link
link-name

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing physical-link

DELETE /network/physical-links/physical-link/{link-name}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/physical-links/physical-link/{link-name}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
link-name

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/physical-links/physical-link/{link-name}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns pnfs

GET /network/pnfs

Tags: Network

returns pnfs
pnf-name

n/a

 query string
nf-naming-code

n/a

 query string
nf-function

n/a

 query string
equip-vendor

n/a

 query string
equip-model

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
phone-number

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

200 OK

successful operation

/pnfs
default

Response codes found in response codes.

returns pnf

GET /network/pnfs/pnf/{pnf-name}

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/pnf
default

Response codes found in response codes.

create or update an existing pnf

PUT /network/pnfs/pnf/{pnf-name}

Tags: Network

create or update an existing pnf

application/json application/xml

pnf object that needs to be created or updated.

/pnf
pnf-name

unique name of Physical Network Function.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing pnf

PATCH /network/pnfs/pnf/{pnf-name}

Tags: Network

update an existing pnf

application/json application/xml

pnf object that needs to be updated.

/zzzz-patch-pnf
pnf-name

unique name of Physical Network Function.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing pnf

DELETE /network/pnfs/pnf/{pnf-name}

Tags: Network

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

default

Response codes found in response codes.

returns activities

GET /network/pnfs/pnf/{pnf-name}/activities

Tags: Network

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

200 OK

successful operation

/activities
default

Response codes found in response codes.

returns activity

GET /network/pnfs/pnf/{pnf-name}/activities/activity/{activity-id}

Tags: Network

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

200 OK

successful operation

/activity
default

Response codes found in response codes.

create or update an existing activity

PUT /network/pnfs/pnf/{pnf-name}/activities/activity/{activity-id}

Tags: Network

create or update an existing activity

application/json application/xml

activity object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing activity

PATCH /network/pnfs/pnf/{pnf-name}/activities/activity/{activity-id}

Tags: Network

update an existing activity

application/json application/xml

activity object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing activity

DELETE /network/pnfs/pnf/{pnf-name}/activities/activity/{activity-id}

Tags: Network

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

default

Response codes found in response codes.

returns activity-states

GET /network/pnfs/pnf/{pnf-name}/activities/activity/{activity-id}/activity-states

Tags: Network

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

200 OK

successful operation

/activity-states
default

Response codes found in response codes.

returns activity-state

GET /network/pnfs/pnf/{pnf-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

Tags: Network

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

200 OK

successful operation

/activity-state
default

Response codes found in response codes.

create or update an existing activity-state

PUT /network/pnfs/pnf/{pnf-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

Tags: Network

create or update an existing activity-state

application/json application/xml

activity-state object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing activity-state

PATCH /network/pnfs/pnf/{pnf-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

Tags: Network

update an existing activity-state

application/json application/xml

activity-state object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing activity-state

DELETE /network/pnfs/pnf/{pnf-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/activities/activity/{activity-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
pnf-name

unique name of Physical Network Function.

 path string
activity-id

Unique id for the activity. (UUID)

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/activities/activity/{activity-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns bgp-groups

GET /network/pnfs/pnf/{pnf-name}/bgp-groups

Tags: Network

returns bgp-groups
pnf-name

unique name of Physical Network Function.

 path string
bgp-group-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

200 OK

successful operation

/bgp-groups
default

Response codes found in response codes.

returns bgp-group

GET /network/pnfs/pnf/{pnf-name}/bgp-groups/bgp-group/{bgp-group-id}

Tags: Network

returns bgp-group
pnf-name

unique name of Physical Network Function.

 path string
bgp-group-id

UUID.

 path string

application/json application/xml

200 OK

successful operation

/bgp-group
default

Response codes found in response codes.

create or update an existing bgp-group

PUT /network/pnfs/pnf/{pnf-name}/bgp-groups/bgp-group/{bgp-group-id}

Tags: Network

create or update an existing bgp-group

application/json application/xml

bgp-group object that needs to be created or updated.

/bgp-group
pnf-name

unique name of Physical Network Function.

 path string
bgp-group-id

UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing bgp-group

PATCH /network/pnfs/pnf/{pnf-name}/bgp-groups/bgp-group/{bgp-group-id}

Tags: Network

update an existing bgp-group

application/json application/xml

bgp-group object that needs to be updated.

/zzzz-patch-bgp-group
pnf-name

unique name of Physical Network Function.

 path string
bgp-group-id

UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing bgp-group

DELETE /network/pnfs/pnf/{pnf-name}/bgp-groups/bgp-group/{bgp-group-id}

Tags: Network

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

default

Response codes found in response codes.

returns address-families

GET /network/pnfs/pnf/{pnf-name}/bgp-groups/bgp-group/{bgp-group-id}/address-families

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/address-families
default

Response codes found in response codes.

returns address-family

GET /network/pnfs/pnf/{pnf-name}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}

Tags: Network

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

200 OK

successful operation

/address-family
default

Response codes found in response codes.

create or update an existing address-family

PUT /network/pnfs/pnf/{pnf-name}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}

Tags: Network

create or update an existing address-family

application/json application/xml

address-family object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing address-family

PATCH /network/pnfs/pnf/{pnf-name}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}

Tags: Network

update an existing address-family

application/json application/xml

address-family object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing address-family

DELETE /network/pnfs/pnf/{pnf-name}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/bgp-groups/bgp-group/{bgp-group-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
pnf-name

unique name of Physical Network Function.

 path string
bgp-group-id

UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/bgp-groups/bgp-group/{bgp-group-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns bgp-neighbors

GET /network/pnfs/pnf/{pnf-name}/bgp-neighbors

Tags: Network

returns bgp-neighbors
pnf-name

unique name of Physical Network Function.

 path string
bgp-neighbor-id

n/a

 query string
prov-status

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

200 OK

successful operation

/bgp-neighbors
default

Response codes found in response codes.

returns bgp-neighbor

GET /network/pnfs/pnf/{pnf-name}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

Tags: Network

returns bgp-neighbor
pnf-name

unique name of Physical Network Function.

 path string
bgp-neighbor-id

UUID.

 path string

application/json application/xml

200 OK

successful operation

/bgp-neighbor
default

Response codes found in response codes.

create or update an existing bgp-neighbor

PUT /network/pnfs/pnf/{pnf-name}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

Tags: Network

create or update an existing bgp-neighbor

application/json application/xml

bgp-neighbor object that needs to be created or updated.

/bgp-neighbor
pnf-name

unique name of Physical Network Function.

 path string
bgp-neighbor-id

UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing bgp-neighbor

PATCH /network/pnfs/pnf/{pnf-name}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

Tags: Network

update an existing bgp-neighbor

application/json application/xml

bgp-neighbor object that needs to be updated.

/zzzz-patch-bgp-neighbor
pnf-name

unique name of Physical Network Function.

 path string
bgp-neighbor-id

UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing bgp-neighbor

DELETE /network/pnfs/pnf/{pnf-name}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

Tags: Network

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

default

Response codes found in response codes.

returns address-families

GET /network/pnfs/pnf/{pnf-name}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/address-families
default

Response codes found in response codes.

returns address-family

GET /network/pnfs/pnf/{pnf-name}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

Tags: Network

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

200 OK

successful operation

/address-family
default

Response codes found in response codes.

create or update an existing address-family

PUT /network/pnfs/pnf/{pnf-name}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

Tags: Network

create or update an existing address-family

application/json application/xml

address-family object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing address-family

PATCH /network/pnfs/pnf/{pnf-name}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

Tags: Network

update an existing address-family

application/json application/xml

address-family object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing address-family

DELETE /network/pnfs/pnf/{pnf-name}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
pnf-name

unique name of Physical Network Function.

 path string
bgp-neighbor-id

UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns l-interfaces

GET /network/pnfs/pnf/{pnf-name}/l-interfaces

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/l-interfaces
default

Response codes found in response codes.

returns l-interface

GET /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}

Tags: Network

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

200 OK

successful operation

/l-interface
default

Response codes found in response codes.

create or update an existing l-interface

PUT /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}

Tags: Network

create or update an existing l-interface

application/json application/xml

l-interface object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing l-interface

PATCH /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}

Tags: Network

update an existing l-interface

application/json application/xml

l-interface object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l-interface

DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv4-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv4-address-list

PUT /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv4-address-list

PATCH /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv4-address-list

DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv6-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv6-address-list

PUT /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv6-address-list

PATCH /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv6-address-list

DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns lcmp-unreachables

GET /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables

Tags: Network

returns lcmp-unreachables
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name given to the interface

 path string
lcmp-unreachable-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

200 OK

successful operation

/lcmp-unreachables
default

Response codes found in response codes.

returns lcmp-unreachable

GET /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: Network

returns lcmp-unreachable
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name given to the interface

 path string
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

200 OK

successful operation

/lcmp-unreachable
default

Response codes found in response codes.

create or update an existing lcmp-unreachable

PUT /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: Network

create or update an existing lcmp-unreachable

application/json application/xml

lcmp-unreachable object that needs to be created or updated.

/lcmp-unreachable
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name given to the interface

 path string
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing lcmp-unreachable

PATCH /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: Network

update an existing lcmp-unreachable

application/json application/xml

lcmp-unreachable object that needs to be updated.

/zzzz-patch-lcmp-unreachable
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name given to the interface

 path string
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing lcmp-unreachable

DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: Network

delete an existing lcmp-unreachable

application/json application/xml

pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name given to the interface

 path string
lcmp-unreachable-id

object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name given to the interface

 path string
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

Tags: Network

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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name given to the interface

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns sriov-vfs

GET /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string
neutron-network-id

n/a

 query string

application/json application/xml

200 OK

successful operation

/sriov-vfs
default

Response codes found in response codes.

returns sriov-vf

GET /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

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

200 OK

successful operation

/sriov-vf
default

Response codes found in response codes.

create or update an existing sriov-vf

PUT /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

create or update an existing sriov-vf

application/json application/xml

sriov-vf object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing sriov-vf

PATCH /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

update an existing sriov-vf

application/json application/xml

sriov-vf object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing sriov-vf

DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns temporary-parameter-lists

GET /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists

Tags: Network

returns temporary-parameter-lists
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name given to the interface

 path string
temporary-parameter-list-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

200 OK

successful operation

/temporary-parameter-lists
default

Response codes found in response codes.

returns temporary-parameter-list

GET /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

returns temporary-parameter-list
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name given to the interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

200 OK

successful operation

/temporary-parameter-list
default

Response codes found in response codes.

create or update an existing temporary-parameter-list

PUT /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

create or update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be created or updated.

/temporary-parameter-list
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name given to the interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing temporary-parameter-list

PATCH /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be updated.

/zzzz-patch-temporary-parameter-list
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name given to the interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing temporary-parameter-list

DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

delete an existing temporary-parameter-list

application/json application/xml

pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name given to the interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name given to the interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: Network

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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

returns vlans

GET /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/vlans

Tags: Network

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
vlan-id-outer

n/a

 query integer
vlan-type

n/a

 query string
vpn-key

n/a

 query string
orchestration-status

n/a

 query string
prov-status

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

200 OK

successful operation

/vlans
default

Response codes found in response codes.

returns vlan

GET /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

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

200 OK

successful operation

/vlan
default

Response codes found in response codes.

create or update an existing vlan

PUT /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

create or update an existing vlan

application/json application/xml

vlan object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing vlan

PATCH /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

update an existing vlan

application/json application/xml

vlan object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing vlan

DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv4-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv4-address-list

PUT /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv4-address-list

PATCH /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv4-address-list

DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv6-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv6-address-list

PUT /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv6-address-list

PATCH /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv6-address-list

DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns lag-interfaces

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string
interface-type

n/a

 query string

application/json application/xml

200 OK

successful operation

/lag-interfaces
default

Response codes found in response codes.

returns lag-interface

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

Tags: Network

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

200 OK

successful operation

/lag-interface
default

Response codes found in response codes.

create or update an existing lag-interface

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

Tags: Network

create or update an existing lag-interface

application/json application/xml

lag-interface object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing lag-interface

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

Tags: Network

update an existing lag-interface

application/json application/xml

lag-interface object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing lag-interface

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

Tags: Network

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

default

Response codes found in response codes.

returns aggregated-ether-options

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options

Tags: Network

returns aggregated-ether-options
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
aggregated-ether-option-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

200 OK

successful operation

/aggregated-ether-options
default

Response codes found in response codes.

returns aggregated-ether-option

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}

Tags: Network

returns aggregated-ether-option
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
aggregated-ether-option-id

UUID - unique object identifier

 path string

application/json application/xml

200 OK

successful operation

/aggregated-ether-option
default

Response codes found in response codes.

create or update an existing aggregated-ether-option

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}

Tags: Network

create or update an existing aggregated-ether-option

application/json application/xml

aggregated-ether-option object that needs to be created or updated.

/aggregated-ether-option
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
aggregated-ether-option-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing aggregated-ether-option

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}

Tags: Network

update an existing aggregated-ether-option

application/json application/xml

aggregated-ether-option object that needs to be updated.

/zzzz-patch-aggregated-ether-option
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
aggregated-ether-option-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing aggregated-ether-option

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}

Tags: Network

delete an existing aggregated-ether-option

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
aggregated-ether-option-id

UUID - unique object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

returns lacps

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps

Tags: Network

returns lacps
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
aggregated-ether-option-id

UUID - unique object identifier

 path string
lacp-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

200 OK

successful operation

/lacps
default

Response codes found in response codes.

returns lacp

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}

Tags: Network

returns lacp
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
aggregated-ether-option-id

UUID - unique object identifier

 path string
lacp-id

UUID- unique object identifier

 path string

application/json application/xml

200 OK

successful operation

/lacp
default

Response codes found in response codes.

create or update an existing lacp

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}

Tags: Network

create or update an existing lacp

application/json application/xml

lacp object that needs to be created or updated.

/lacp
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
aggregated-ether-option-id

UUID - unique object identifier

 path string
lacp-id

UUID- unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing lacp

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}

Tags: Network

update an existing lacp

application/json application/xml

lacp object that needs to be updated.

/zzzz-patch-lacp
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
aggregated-ether-option-id

UUID - unique object identifier

 path string
lacp-id

UUID- unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing lacp

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}

Tags: Network

delete an existing lacp

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
aggregated-ether-option-id

UUID - unique object identifier

 path string
lacp-id

UUID- unique object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
aggregated-ether-option-id

UUID - unique object identifier

 path string
lacp-id

UUID- unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}/relationship-list/relationship

Tags: Network

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
aggregated-ether-option-id

UUID - unique object identifier

 path string
lacp-id

UUID- unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
aggregated-ether-option-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/relationship-list/relationship

Tags: Network

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
aggregated-ether-option-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

returns esis

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/esis

Tags: Network

returns esis
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
esi-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

200 OK

successful operation

/esis
default

Response codes found in response codes.

returns esi

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}

Tags: Network

returns esi
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
esi-id

object identifier

 path string

application/json application/xml

200 OK

successful operation

/esi
default

Response codes found in response codes.

create or update an existing esi

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}

Tags: Network

create or update an existing esi

application/json application/xml

esi object that needs to be created or updated.

/esi
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
esi-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing esi

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}

Tags: Network

update an existing esi

application/json application/xml

esi object that needs to be updated.

/zzzz-patch-esi
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
esi-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing esi

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}

Tags: Network

delete an existing esi

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
esi-id

object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
esi-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}/relationship-list/relationship

Tags: Network

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
esi-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

returns l-interfaces

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/l-interfaces
default

Response codes found in response codes.

returns l-interface

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

Tags: Network

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

200 OK

successful operation

/l-interface
default

Response codes found in response codes.

create or update an existing l-interface

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

Tags: Network

create or update an existing l-interface

application/json application/xml

l-interface object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing l-interface

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

Tags: Network

update an existing l-interface

application/json application/xml

l-interface object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l-interface

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv4-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv4-address-list

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv4-address-list

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv4-address-list

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv6-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv6-address-list

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv6-address-list

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv6-address-list

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns lcmp-unreachables

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables

Tags: Network

returns lcmp-unreachables
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
lcmp-unreachable-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

200 OK

successful operation

/lcmp-unreachables
default

Response codes found in response codes.

returns lcmp-unreachable

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: Network

returns lcmp-unreachable
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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

200 OK

successful operation

/lcmp-unreachable
default

Response codes found in response codes.

create or update an existing lcmp-unreachable

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: Network

create or update an existing lcmp-unreachable

application/json application/xml

lcmp-unreachable object that needs to be created or updated.

/lcmp-unreachable
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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing lcmp-unreachable

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: Network

update an existing lcmp-unreachable

application/json application/xml

lcmp-unreachable object that needs to be updated.

/zzzz-patch-lcmp-unreachable
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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing lcmp-unreachable

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: Network

delete an existing lcmp-unreachable

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
lcmp-unreachable-id

object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

Tags: Network

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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns sriov-vfs

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string
neutron-network-id

n/a

 query string

application/json application/xml

200 OK

successful operation

/sriov-vfs
default

Response codes found in response codes.

returns sriov-vf

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

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

200 OK

successful operation

/sriov-vf
default

Response codes found in response codes.

create or update an existing sriov-vf

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

create or update an existing sriov-vf

application/json application/xml

sriov-vf object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing sriov-vf

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

update an existing sriov-vf

application/json application/xml

sriov-vf object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing sriov-vf

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns temporary-parameter-lists

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists

Tags: Network

returns temporary-parameter-lists
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
temporary-parameter-list-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

200 OK

successful operation

/temporary-parameter-lists
default

Response codes found in response codes.

returns temporary-parameter-list

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

returns temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

200 OK

successful operation

/temporary-parameter-list
default

Response codes found in response codes.

create or update an existing temporary-parameter-list

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

create or update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be created or updated.

/temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing temporary-parameter-list

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be updated.

/zzzz-patch-temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing temporary-parameter-list

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

delete an existing temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: Network

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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

returns vlans

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans

Tags: Network

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
vlan-id-outer

n/a

 query integer
vlan-type

n/a

 query string
vpn-key

n/a

 query string
orchestration-status

n/a

 query string
prov-status

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

200 OK

successful operation

/vlans
default

Response codes found in response codes.

returns vlan

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

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

200 OK

successful operation

/vlan
default

Response codes found in response codes.

create or update an existing vlan

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

create or update an existing vlan

application/json application/xml

vlan object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing vlan

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

update an existing vlan

application/json application/xml

vlan object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing vlan

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv4-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv4-address-list

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv4-address-list

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv4-address-list

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv6-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv6-address-list

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv6-address-list

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv6-address-list

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv4-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv4-address-list

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv4-address-list

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv4-address-list

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv6-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv6-address-list

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv6-address-list

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv6-address-list

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns temporary-parameter-lists

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists

Tags: Network

returns temporary-parameter-lists
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
temporary-parameter-list-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

200 OK

successful operation

/temporary-parameter-lists
default

Response codes found in response codes.

returns temporary-parameter-list

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

returns temporary-parameter-list
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

200 OK

successful operation

/temporary-parameter-list
default

Response codes found in response codes.

create or update an existing temporary-parameter-list

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

create or update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be created or updated.

/temporary-parameter-list
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing temporary-parameter-list

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be updated.

/zzzz-patch-temporary-parameter-list
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing temporary-parameter-list

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

delete an existing temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: Network

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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

returns p-interfaces

GET /network/pnfs/pnf/{pnf-name}/p-interfaces

Tags: Network

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
interface-type

n/a

 query string
prov-status

n/a

 query string
inv-status

n/a

 query string
interface-function

n/a

 query string
macaddr

n/a

 query string
network-ref

n/a

 query string
operational-status

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

200 OK

successful operation

/p-interfaces
default

Response codes found in response codes.

returns p-interface

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

Tags: Network

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

200 OK

successful operation

/p-interface
default

Response codes found in response codes.

create or update an existing p-interface

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

Tags: Network

create or update an existing p-interface

application/json application/xml

p-interface object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing p-interface

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

Tags: Network

update an existing p-interface

application/json application/xml

p-interface object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing p-interface

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

Tags: Network

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

default

Response codes found in response codes.

returns activities

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/activities

Tags: Network

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

200 OK

successful operation

/activities
default

Response codes found in response codes.

returns activity

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}

Tags: Network

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

200 OK

successful operation

/activity
default

Response codes found in response codes.

create or update an existing activity

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}

Tags: Network

create or update an existing activity

application/json application/xml

activity object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing activity

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}

Tags: Network

update an existing activity

application/json application/xml

activity object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing activity

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}

Tags: Network

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

default

Response codes found in response codes.

returns activity-states

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states

Tags: Network

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

200 OK

successful operation

/activity-states
default

Response codes found in response codes.

returns activity-state

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

Tags: Network

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

200 OK

successful operation

/activity-state
default

Response codes found in response codes.

create or update an existing activity-state

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

Tags: Network

create or update an existing activity-state

application/json application/xml

activity-state object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing activity-state

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

Tags: Network

update an existing activity-state

application/json application/xml

activity-state object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing activity-state

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns bandwidth-attributes

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/bandwidth-attributes
default

Response codes found in response codes.

returns bandwidth-attribute

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}

Tags: Network

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

200 OK

successful operation

/bandwidth-attribute
default

Response codes found in response codes.

create or update an existing bandwidth-attribute

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}

Tags: Network

create or update an existing bandwidth-attribute

application/json application/xml

bandwidth-attribute object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing bandwidth-attribute

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}

Tags: Network

update an existing bandwidth-attribute

application/json application/xml

bandwidth-attribute object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing bandwidth-attribute

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}

Tags: Network

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

default

Response codes found in response codes.

returns available-bandwidth-map

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/available-bandwidth-map
default

Response codes found in response codes.

returns available-bandwidth

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}

Tags: Network

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

200 OK

successful operation

/available-bandwidth
default

Response codes found in response codes.

create or update an existing available-bandwidth

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}

Tags: Network

create or update an existing available-bandwidth

application/json application/xml

available-bandwidth object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing available-bandwidth

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}

Tags: Network

update an existing available-bandwidth

application/json application/xml

available-bandwidth object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing available-bandwidth

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns gig-ether-options

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/gig-ether-options

Tags: Network

returns gig-ether-options
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the physical interface

 path string
gig-ether-option-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

200 OK

successful operation

/gig-ether-options
default

Response codes found in response codes.

returns gig-ether-option

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}

Tags: Network

returns gig-ether-option
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the physical interface

 path string
gig-ether-option-id

UUID - unique object identifier

 path string

application/json application/xml

200 OK

successful operation

/gig-ether-option
default

Response codes found in response codes.

create or update an existing gig-ether-option

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}

Tags: Network

create or update an existing gig-ether-option

application/json application/xml

gig-ether-option object that needs to be created or updated.

/gig-ether-option
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the physical interface

 path string
gig-ether-option-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing gig-ether-option

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}

Tags: Network

update an existing gig-ether-option

application/json application/xml

gig-ether-option object that needs to be updated.

/zzzz-patch-gig-ether-option
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the physical interface

 path string
gig-ether-option-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing gig-ether-option

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}

Tags: Network

delete an existing gig-ether-option

application/json application/xml

pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the physical interface

 path string
gig-ether-option-id

UUID - unique object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the physical interface

 path string
gig-ether-option-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}/relationship-list/relationship

Tags: Network

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
gig-ether-option-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

returns hold-timers

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/hold-timers

Tags: Network

returns hold-timers
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the physical interface

 path string
hold-timer-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

200 OK

successful operation

/hold-timers
default

Response codes found in response codes.

returns hold-timer

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/hold-timers/hold-timer/{hold-timer-id}

Tags: Network

returns hold-timer
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the physical interface

 path string
hold-timer-id

UUID - unique object identifier

 path string

application/json application/xml

200 OK

successful operation

/hold-timer
default

Response codes found in response codes.

create or update an existing hold-timer

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/hold-timers/hold-timer/{hold-timer-id}

Tags: Network

create or update an existing hold-timer

application/json application/xml

hold-timer object that needs to be created or updated.

/hold-timer
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the physical interface

 path string
hold-timer-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing hold-timer

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/hold-timers/hold-timer/{hold-timer-id}

Tags: Network

update an existing hold-timer

application/json application/xml

hold-timer object that needs to be updated.

/zzzz-patch-hold-timer
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the physical interface

 path string
hold-timer-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing hold-timer

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/hold-timers/hold-timer/{hold-timer-id}

Tags: Network

delete an existing hold-timer

application/json application/xml

pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the physical interface

 path string
hold-timer-id

UUID - unique object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/hold-timers/hold-timer/{hold-timer-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the physical interface

 path string
hold-timer-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/hold-timers/hold-timer/{hold-timer-id}/relationship-list/relationship

Tags: Network

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
hold-timer-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

returns l-interfaces

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/l-interfaces
default

Response codes found in response codes.

returns l-interface

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

Tags: Network

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

200 OK

successful operation

/l-interface
default

Response codes found in response codes.

create or update an existing l-interface

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

Tags: Network

create or update an existing l-interface

application/json application/xml

l-interface object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing l-interface

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

Tags: Network

update an existing l-interface

application/json application/xml

l-interface object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l-interface

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv4-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv4-address-list

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv4-address-list

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv4-address-list

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv6-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv6-address-list

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv6-address-list

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv6-address-list

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns lcmp-unreachables

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables

Tags: Network

returns lcmp-unreachables
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
lcmp-unreachable-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

200 OK

successful operation

/lcmp-unreachables
default

Response codes found in response codes.

returns lcmp-unreachable

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: Network

returns lcmp-unreachable
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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

200 OK

successful operation

/lcmp-unreachable
default

Response codes found in response codes.

create or update an existing lcmp-unreachable

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: Network

create or update an existing lcmp-unreachable

application/json application/xml

lcmp-unreachable object that needs to be created or updated.

/lcmp-unreachable
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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing lcmp-unreachable

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: Network

update an existing lcmp-unreachable

application/json application/xml

lcmp-unreachable object that needs to be updated.

/zzzz-patch-lcmp-unreachable
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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing lcmp-unreachable

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: Network

delete an existing lcmp-unreachable

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
lcmp-unreachable-id

object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

Tags: Network

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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns sriov-vfs

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string
neutron-network-id

n/a

 query string

application/json application/xml

200 OK

successful operation

/sriov-vfs
default

Response codes found in response codes.

returns sriov-vf

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

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

200 OK

successful operation

/sriov-vf
default

Response codes found in response codes.

create or update an existing sriov-vf

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

create or update an existing sriov-vf

application/json application/xml

sriov-vf object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing sriov-vf

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

update an existing sriov-vf

application/json application/xml

sriov-vf object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing sriov-vf

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns temporary-parameter-lists

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists

Tags: Network

returns temporary-parameter-lists
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
temporary-parameter-list-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

200 OK

successful operation

/temporary-parameter-lists
default

Response codes found in response codes.

returns temporary-parameter-list

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

returns temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

200 OK

successful operation

/temporary-parameter-list
default

Response codes found in response codes.

create or update an existing temporary-parameter-list

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

create or update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be created or updated.

/temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing temporary-parameter-list

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be updated.

/zzzz-patch-temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing temporary-parameter-list

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

delete an existing temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: Network

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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

returns vlans

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans

Tags: Network

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
vlan-id-outer

n/a

 query integer
vlan-type

n/a

 query string
vpn-key

n/a

 query string
orchestration-status

n/a

 query string
prov-status

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

200 OK

successful operation

/vlans
default

Response codes found in response codes.

returns vlan

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

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

200 OK

successful operation

/vlan
default

Response codes found in response codes.

create or update an existing vlan

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

create or update an existing vlan

application/json application/xml

vlan object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing vlan

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

update an existing vlan

application/json application/xml

vlan object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing vlan

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv4-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv4-address-list

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv4-address-list

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv4-address-list

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv6-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv6-address-list

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv6-address-list

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv6-address-list

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv4-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv4-address-list

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv4-address-list

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv4-address-list

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv6-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv6-address-list

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv6-address-list

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv6-address-list

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the physical interface

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns sriov-pfs

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/sriov-pfs
default

Response codes found in response codes.

returns sriov-pf

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

Tags: Network

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

200 OK

successful operation

/sriov-pf
default

Response codes found in response codes.

create or update an existing sriov-pf

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

Tags: Network

create or update an existing sriov-pf

application/json application/xml

sriov-pf object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing sriov-pf

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

Tags: Network

update an existing sriov-pf

application/json application/xml

sriov-pf object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing sriov-pf

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns temporary-parameter-lists

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists

Tags: Network

returns temporary-parameter-lists
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the physical interface

 path string
temporary-parameter-list-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

200 OK

successful operation

/temporary-parameter-lists
default

Response codes found in response codes.

returns temporary-parameter-list

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

returns temporary-parameter-list
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the physical interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

200 OK

successful operation

/temporary-parameter-list
default

Response codes found in response codes.

create or update an existing temporary-parameter-list

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

create or update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be created or updated.

/temporary-parameter-list
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the physical interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing temporary-parameter-list

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be updated.

/zzzz-patch-temporary-parameter-list
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the physical interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing temporary-parameter-list

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

delete an existing temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the physical interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: Network

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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
pnf-name

unique name of Physical Network Function.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

pnf-name

unique name of Physical Network Function.

 path string

application/json application/xml

default

Response codes found in response codes.

returns software-versions

GET /network/pnfs/pnf/{pnf-name}/software-versions

Tags: Network

returns software-versions
pnf-name

unique name of Physical Network Function.

 path string

application/json application/xml

200 OK

successful operation

/software-versions
default

Response codes found in response codes.

returns software-version

GET /network/pnfs/pnf/{pnf-name}/software-versions/software-version/{software-version-id}

Tags: Network

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

200 OK

successful operation

/software-version
default

Response codes found in response codes.

create or update an existing software-version

PUT /network/pnfs/pnf/{pnf-name}/software-versions/software-version/{software-version-id}

Tags: Network

create or update an existing software-version

application/json application/xml

software-version object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing software-version

PATCH /network/pnfs/pnf/{pnf-name}/software-versions/software-version/{software-version-id}

Tags: Network

update an existing software-version

application/json application/xml

software-version object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing software-version

DELETE /network/pnfs/pnf/{pnf-name}/software-versions/software-version/{software-version-id}

Tags: Network

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

default

Response codes found in response codes.

returns vrfs

GET /network/pnfs/pnf/{pnf-name}/vrfs

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/vrfs
default

Response codes found in response codes.

returns vrf

GET /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}

Tags: Network

returns vrf
pnf-name

unique name of Physical Network Function.

 path string
vrf-id

VRF UUID.

 path string

application/json application/xml

200 OK

successful operation

/vrf
default

Response codes found in response codes.

create or update an existing vrf

PUT /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}

Tags: Network

create or update an existing vrf

application/json application/xml

vrf object that needs to be created or updated.

/vrf
pnf-name

unique name of Physical Network Function.

 path string
vrf-id

VRF UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing vrf

PATCH /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}

Tags: Network

update an existing vrf

application/json application/xml

vrf object that needs to be updated.

/zzzz-patch-vrf
pnf-name

unique name of Physical Network Function.

 path string
vrf-id

VRF UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing vrf

DELETE /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}

Tags: Network

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

default

Response codes found in response codes.

returns aggregate-routes

GET /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/aggregate-routes

Tags: Network

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
next-hop

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

200 OK

successful operation

/aggregate-routes
default

Response codes found in response codes.

returns aggregate-route

GET /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/aggregate-routes/aggregate-route/{agg-route-id}

Tags: Network

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

200 OK

successful operation

/aggregate-route
default

Response codes found in response codes.

create or update an existing aggregate-route

PUT /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/aggregate-routes/aggregate-route/{agg-route-id}

Tags: Network

create or update an existing aggregate-route

application/json application/xml

aggregate-route object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing aggregate-route

PATCH /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/aggregate-routes/aggregate-route/{agg-route-id}

Tags: Network

update an existing aggregate-route

application/json application/xml

aggregate-route object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing aggregate-route

DELETE /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/aggregate-routes/aggregate-route/{agg-route-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/aggregate-routes/aggregate-route/{agg-route-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/aggregate-routes/aggregate-route/{agg-route-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns bgp-groups

GET /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-groups

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/bgp-groups
default

Response codes found in response codes.

returns bgp-group

GET /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-groups/bgp-group/{bgp-group-id}

Tags: Network

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

200 OK

successful operation

/bgp-group
default

Response codes found in response codes.

create or update an existing bgp-group

PUT /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-groups/bgp-group/{bgp-group-id}

Tags: Network

create or update an existing bgp-group

application/json application/xml

bgp-group object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing bgp-group

PATCH /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-groups/bgp-group/{bgp-group-id}

Tags: Network

update an existing bgp-group

application/json application/xml

bgp-group object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing bgp-group

DELETE /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-groups/bgp-group/{bgp-group-id}

Tags: Network

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

default

Response codes found in response codes.

returns address-families

GET /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-groups/bgp-group/{bgp-group-id}/address-families

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/address-families
default

Response codes found in response codes.

returns address-family

GET /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}

Tags: Network

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

200 OK

successful operation

/address-family
default

Response codes found in response codes.

create or update an existing address-family

PUT /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}

Tags: Network

create or update an existing address-family

application/json application/xml

address-family object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing address-family

PATCH /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}

Tags: Network

update an existing address-family

application/json application/xml

address-family object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing address-family

DELETE /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-groups/bgp-group/{bgp-group-id}/address-families/address-family/{address-family-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-groups/bgp-group/{bgp-group-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-groups/bgp-group/{bgp-group-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns bgp-neighbors

GET /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-neighbors

Tags: Network

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
prov-status

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

200 OK

successful operation

/bgp-neighbors
default

Response codes found in response codes.

returns bgp-neighbor

GET /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

Tags: Network

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

200 OK

successful operation

/bgp-neighbor
default

Response codes found in response codes.

create or update an existing bgp-neighbor

PUT /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

Tags: Network

create or update an existing bgp-neighbor

application/json application/xml

bgp-neighbor object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing bgp-neighbor

PATCH /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

Tags: Network

update an existing bgp-neighbor

application/json application/xml

bgp-neighbor object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing bgp-neighbor

DELETE /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

Tags: Network

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

default

Response codes found in response codes.

returns address-families

GET /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/address-families
default

Response codes found in response codes.

returns address-family

GET /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

Tags: Network

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

200 OK

successful operation

/address-family
default

Response codes found in response codes.

create or update an existing address-family

PUT /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

Tags: Network

create or update an existing address-family

application/json application/xml

address-family object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing address-family

PATCH /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

Tags: Network

update an existing address-family

application/json application/xml

address-family object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing address-family

DELETE /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
pnf-name

unique name of Physical Network Function.

 path string
vrf-id

VRF UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns route-targets

GET /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/route-targets

Tags: Network

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

200 OK

successful operation

/route-targets
default

Response codes found in response codes.

returns route-target

GET /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/route-targets/route-target/{global-route-target}/{route-target-role}

Tags: Network

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

200 OK

successful operation

/route-target
default

Response codes found in response codes.

create or update an existing route-target

PUT /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/route-targets/route-target/{global-route-target}/{route-target-role}

Tags: Network

create or update an existing route-target

application/json application/xml

route-target object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing route-target

PATCH /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/route-targets/route-target/{global-route-target}/{route-target-role}

Tags: Network

update an existing route-target

application/json application/xml

route-target object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing route-target

DELETE /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/route-targets/route-target/{global-route-target}/{route-target-role}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns route-table-references

GET /network/route-table-references

Tags: Network

returns route-table-references
route-table-reference-id

n/a

 query string
route-table-reference-fqdn

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

200 OK

successful operation

/route-table-references
default

Response codes found in response codes.

returns route-table-reference

GET /network/route-table-references/route-table-reference/{route-table-reference-id}

Tags: Network

returns route-table-reference
route-table-reference-id

Route Table Reference id, UUID assigned to this instance.

 path string

application/json application/xml

200 OK

successful operation

/route-table-reference
default

Response codes found in response codes.

create or update an existing route-table-reference

PUT /network/route-table-references/route-table-reference/{route-table-reference-id}

Tags: Network

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
route-table-reference-id

Route Table Reference id, UUID assigned to this instance.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing route-table-reference

PATCH /network/route-table-references/route-table-reference/{route-table-reference-id}

Tags: Network

update an existing route-table-reference

application/json application/xml

route-table-reference object that needs to be updated.

/zzzz-patch-route-table-reference
route-table-reference-id

Route Table Reference id, UUID assigned to this instance.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing route-table-reference

DELETE /network/route-table-references/route-table-reference/{route-table-reference-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
route-table-reference-id

Route Table Reference id, UUID assigned to this instance.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns sdwan-vpns

GET /network/sdwan-vpns

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/sdwan-vpns
default

Response codes found in response codes.

returns sdwan-vpn

GET /network/sdwan-vpns/sdwan-vpn/{sdwan-vpn-id}

Tags: Network

returns sdwan-vpn
sdwan-vpn-id

Uniquely identifies this sdwan-vpn by id

 path string

application/json application/xml

200 OK

successful operation

/sdwan-vpn
default

Response codes found in response codes.

create or update an existing sdwan-vpn

PUT /network/sdwan-vpns/sdwan-vpn/{sdwan-vpn-id}

Tags: Network

create or update an existing sdwan-vpn

application/json application/xml

sdwan-vpn object that needs to be created or updated.

/sdwan-vpn
sdwan-vpn-id

Uniquely identifies this sdwan-vpn by id

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing sdwan-vpn

PATCH /network/sdwan-vpns/sdwan-vpn/{sdwan-vpn-id}

Tags: Network

update an existing sdwan-vpn

application/json application/xml

sdwan-vpn object that needs to be updated.

/zzzz-patch-sdwan-vpn
sdwan-vpn-id

Uniquely identifies this sdwan-vpn by id

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing sdwan-vpn

DELETE /network/sdwan-vpns/sdwan-vpn/{sdwan-vpn-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/sdwan-vpns/sdwan-vpn/{sdwan-vpn-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
sdwan-vpn-id

Uniquely identifies this sdwan-vpn by id

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/sdwan-vpns/sdwan-vpn/{sdwan-vpn-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

sdwan-vpn-id

Uniquely identifies this sdwan-vpn by id

 path string

application/json application/xml

default

Response codes found in response codes.

returns site-pair-sets

GET /network/site-pair-sets

Tags: Network

returns site-pair-sets
site-pair-set-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

200 OK

successful operation

/site-pair-sets
default

Response codes found in response codes.

returns site-pair-set

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}

Tags: Network

returns site-pair-set
site-pair-set-id

Unique id of site pair set.

 path string

application/json application/xml

200 OK

successful operation

/site-pair-set
default

Response codes found in response codes.

create or update an existing site-pair-set

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}

Tags: Network

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
site-pair-set-id

Unique id of site pair set.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing site-pair-set

PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}

Tags: Network

update an existing site-pair-set

application/json application/xml

site-pair-set object that needs to be updated.

/zzzz-patch-site-pair-set
site-pair-set-id

Unique id of site pair set.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing site-pair-set

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
site-pair-set-id

Unique id of site pair set.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

site-pair-set-id

Unique id of site pair set.

 path string

application/json application/xml

default

Response codes found in response codes.

returns routing-instances

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances

Tags: Network

returns routing-instances
site-pair-set-id

Unique id of site pair set.

 path string
routing-instance-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

200 OK

successful operation

/routing-instances
default

Response codes found in response codes.

returns routing-instance

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

Tags: Network

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

200 OK

successful operation

/routing-instance
default

Response codes found in response codes.

create or update an existing routing-instance

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

Tags: Network

create or update an existing routing-instance

application/json application/xml

routing-instance object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing routing-instance

PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

Tags: Network

update an existing routing-instance

application/json application/xml

routing-instance object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing routing-instance

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns site-pairs

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/site-pairs
default

Response codes found in response codes.

returns site-pair

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}

Tags: Network

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

200 OK

successful operation

/site-pair
default

Response codes found in response codes.

create or update an existing site-pair

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}

Tags: Network

create or update an existing site-pair

application/json application/xml

site-pair object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing site-pair

PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}

Tags: Network

update an existing site-pair

application/json application/xml

site-pair object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing site-pair

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}

Tags: Network

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

default

Response codes found in response codes.

returns classes-of-service

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/classes-of-service
default

Response codes found in response codes.

returns class-of-service

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}

Tags: Network

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

200 OK

successful operation

/class-of-service
default

Response codes found in response codes.

create or update an existing class-of-service

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}

Tags: Network

create or update an existing class-of-service

application/json application/xml

class-of-service object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing class-of-service

PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}

Tags: Network

update an existing class-of-service

application/json application/xml

class-of-service object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing class-of-service

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns site-resources

GET /network/site-resources

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/site-resources
default

Response codes found in response codes.

returns site-resource

GET /network/site-resources/site-resource/{site-resource-id}

Tags: Network

returns site-resource
site-resource-id

Uniquely identifies this site-resource by id

 path string

application/json application/xml

200 OK

successful operation

/site-resource
default

Response codes found in response codes.

create or update an existing site-resource

PUT /network/site-resources/site-resource/{site-resource-id}

Tags: Network

create or update an existing site-resource

application/json application/xml

site-resource object that needs to be created or updated.

/site-resource
site-resource-id

Uniquely identifies this site-resource by id

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing site-resource

PATCH /network/site-resources/site-resource/{site-resource-id}

Tags: Network

update an existing site-resource

application/json application/xml

site-resource object that needs to be updated.

/zzzz-patch-site-resource
site-resource-id

Uniquely identifies this site-resource by id

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing site-resource

DELETE /network/site-resources/site-resource/{site-resource-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/site-resources/site-resource/{site-resource-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
site-resource-id

Uniquely identifies this site-resource by id

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/site-resources/site-resource/{site-resource-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

site-resource-id

Uniquely identifies this site-resource by id

 path string

application/json application/xml

default

Response codes found in response codes.

returns sw-components

GET /network/sw-components

Tags: Network

returns sw-components
sw-component-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

200 OK

successful operation

/sw-components
default

Response codes found in response codes.

returns sw-component

GET /network/sw-components/sw-component/{sw-component-id}

Tags: Network

returns sw-component
sw-component-id

UUID

 path string

application/json application/xml

200 OK

successful operation

/sw-component
default

Response codes found in response codes.

create or update an existing sw-component

PUT /network/sw-components/sw-component/{sw-component-id}

Tags: Network

create or update an existing sw-component

application/json application/xml

sw-component object that needs to be created or updated.

/sw-component
sw-component-id

UUID

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing sw-component

PATCH /network/sw-components/sw-component/{sw-component-id}

Tags: Network

update an existing sw-component

application/json application/xml

sw-component object that needs to be updated.

/zzzz-patch-sw-component
sw-component-id

UUID

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing sw-component

DELETE /network/sw-components/sw-component/{sw-component-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/sw-components/sw-component/{sw-component-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
sw-component-id

UUID

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/sw-components/sw-component/{sw-component-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

sw-component-id

UUID

 path string

application/json application/xml

default

Response codes found in response codes.

returns te-link-attributes

GET /network/te-link-attributes

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/te-link-attributes
default

Response codes found in response codes.

returns te-link-attribute

GET /network/te-link-attributes/te-link-attribute/{id}

Tags: Network

returns te-link-attribute
id

Id that identifies the TE link attribute

 path string

application/json application/xml

200 OK

successful operation

/te-link-attribute
default

Response codes found in response codes.

create or update an existing te-link-attribute

PUT /network/te-link-attributes/te-link-attribute/{id}

Tags: Network

create or update an existing te-link-attribute

application/json application/xml

te-link-attribute object that needs to be created or updated.

/te-link-attribute
id

Id that identifies the TE link attribute

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing te-link-attribute

PATCH /network/te-link-attributes/te-link-attribute/{id}

Tags: Network

update an existing te-link-attribute

application/json application/xml

te-link-attribute object that needs to be updated.

/zzzz-patch-te-link-attribute
id

Id that identifies the TE link attribute

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing te-link-attribute

DELETE /network/te-link-attributes/te-link-attribute/{id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/te-link-attributes/te-link-attribute/{id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
id

Id that identifies the TE link attribute

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/te-link-attributes/te-link-attribute/{id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

id

Id that identifies the TE link attribute

 path string

application/json application/xml

default

Response codes found in response codes.

returns tunnel-termination-points

GET /network/tunnel-termination-points

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/tunnel-termination-points
default

Response codes found in response codes.

returns tunnel-termination-point

GET /network/tunnel-termination-points/tunnel-termination-point/{ttp-id}

Tags: Network

returns tunnel-termination-point
ttp-id

Id that identifies the tunnel termination point

 path string

application/json application/xml

200 OK

successful operation

/tunnel-termination-point
default

Response codes found in response codes.

create or update an existing tunnel-termination-point

PUT /network/tunnel-termination-points/tunnel-termination-point/{ttp-id}

Tags: Network

create or update an existing tunnel-termination-point

application/json application/xml

tunnel-termination-point object that needs to be created or updated.

/tunnel-termination-point
ttp-id

Id that identifies the tunnel termination point

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing tunnel-termination-point

PATCH /network/tunnel-termination-points/tunnel-termination-point/{ttp-id}

Tags: Network

update an existing tunnel-termination-point

application/json application/xml

tunnel-termination-point object that needs to be updated.

/zzzz-patch-tunnel-termination-point
ttp-id

Id that identifies the tunnel termination point

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing tunnel-termination-point

DELETE /network/tunnel-termination-points/tunnel-termination-point/{ttp-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/tunnel-termination-points/tunnel-termination-point/{ttp-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
ttp-id

Id that identifies the tunnel termination point

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/tunnel-termination-points/tunnel-termination-point/{ttp-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

ttp-id

Id that identifies the tunnel termination point

 path string

application/json application/xml

default

Response codes found in response codes.

returns unis

GET /network/unis

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/unis
default

Response codes found in response codes.

returns uni

GET /network/unis/uni/{id}

Tags: Network

returns uni
id

Id that identifies the UNI

 path string

application/json application/xml

200 OK

successful operation

/uni
default

Response codes found in response codes.

create or update an existing uni

PUT /network/unis/uni/{id}

Tags: Network

create or update an existing uni

application/json application/xml

uni object that needs to be created or updated.

/uni
id

Id that identifies the UNI

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing uni

PATCH /network/unis/uni/{id}

Tags: Network

update an existing uni

application/json application/xml

uni object that needs to be updated.

/zzzz-patch-uni
id

Id that identifies the UNI

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing uni

DELETE /network/unis/uni/{id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/unis/uni/{id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
id

Id that identifies the UNI

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/unis/uni/{id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

id

Id that identifies the UNI

 path string

application/json application/xml

default

Response codes found in response codes.

returns vces

GET /network/vces

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/vces
default

Response codes found in response codes.

returns vce

GET /network/vces/vce/{vnf-id}

Tags: Network

returns vce
vnf-id

Unique id of VNF. This is unique across the graph.

 path string

application/json application/xml

200 OK

successful operation

/vce
default

Response codes found in response codes.

create or update an existing vce

PUT /network/vces/vce/{vnf-id}

Tags: Network

create or update an existing vce

application/json application/xml

vce object that needs to be created or updated.

/vce
vnf-id

Unique id of VNF. This is unique across the graph.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing vce

PATCH /network/vces/vce/{vnf-id}

Tags: Network

update an existing vce

application/json application/xml

vce object that needs to be updated.

/zzzz-patch-vce
vnf-id

Unique id of VNF. This is unique across the graph.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing vce

DELETE /network/vces/vce/{vnf-id}

Tags: Network

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

default

Response codes found in response codes.

returns entitlements

GET /network/vces/vce/{vnf-id}/entitlements

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/entitlements
default

Response codes found in response codes.

returns entitlement

GET /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

Tags: Network

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

200 OK

successful operation

/entitlement
default

Response codes found in response codes.

create or update an existing entitlement

PUT /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

Tags: Network

create or update an existing entitlement

application/json application/xml

entitlement object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing entitlement

PATCH /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

Tags: Network

update an existing entitlement

application/json application/xml

entitlement object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing entitlement

DELETE /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns licenses

GET /network/vces/vce/{vnf-id}/licenses

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/licenses
default

Response codes found in response codes.

returns license

GET /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

Tags: Network

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

200 OK

successful operation

/license
default

Response codes found in response codes.

create or update an existing license

PUT /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

Tags: Network

create or update an existing license

application/json application/xml

license object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing license

PATCH /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

Tags: Network

update an existing license

application/json application/xml

license object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing license

DELETE /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns port-groups

GET /network/vces/vce/{vnf-id}/port-groups

Tags: Network

returns port-groups
vnf-id

Unique id of VNF. This is unique across the graph.

 path string
interface-id

n/a

 query string
neutron-network-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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/port-groups
default

Response codes found in response codes.

returns port-group

GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

Tags: Network

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

200 OK

successful operation

/port-group
default

Response codes found in response codes.

create or update an existing port-group

PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

Tags: Network

create or update an existing port-group

application/json application/xml

port-group object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing port-group

PATCH /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

Tags: Network

update an existing port-group

application/json application/xml

port-group object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing port-group

DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

Tags: Network

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

default

Response codes found in response codes.

returns cvlan-tags

GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags

Tags: Network

returns cvlan-tags
vnf-id

Unique id of VNF. This is unique across the graph.

 path string
interface-id

Unique ID of the interface

 path string
cvlan-tag

n/a

 query integer
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/cvlan-tags
default

Response codes found in response codes.

returns cvlan-tag-entry

GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

Tags: Network

returns cvlan-tag-entry
vnf-id

Unique id of VNF. This is unique across the graph.

 path string
interface-id

Unique ID of the interface

 path string
cvlan-tag

See mis-na-virtualization-platform.yang

 path integer

application/json application/xml

200 OK

successful operation

/cvlan-tag-entry
default

Response codes found in response codes.

create or update an existing cvlan-tag-entry

PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

Tags: Network

create or update an existing cvlan-tag-entry

application/json application/xml

cvlan-tag-entry object that needs to be created or updated.

/cvlan-tag-entry
vnf-id

Unique id of VNF. This is unique across the graph.

 path string
interface-id

Unique ID of the interface

 path string
cvlan-tag

See mis-na-virtualization-platform.yang

 path integer

application/json application/xml

default

Response codes found in response codes.

update an existing cvlan-tag-entry

PATCH /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

Tags: Network

update an existing cvlan-tag-entry

application/json application/xml

cvlan-tag-entry object that needs to be updated.

/zzzz-patch-cvlan-tag-entry
vnf-id

Unique id of VNF. This is unique across the graph.

 path string
interface-id

Unique ID of the interface

 path string
cvlan-tag

See mis-na-virtualization-platform.yang

 path integer

application/json application/xml

default

Response codes found in response codes.

delete an existing cvlan-tag-entry

DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

Tags: Network

delete an existing cvlan-tag-entry

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
cvlan-tag

See mis-na-virtualization-platform.yang

 path integer
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
vnf-id

Unique id of VNF. This is unique across the graph.

 path string
interface-id

Unique ID of the interface

 path string
cvlan-tag

See mis-na-virtualization-platform.yang

 path integer

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship

Tags: Network

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
cvlan-tag

See mis-na-virtualization-platform.yang

 path integer

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vces/vce/{vnf-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
vnf-id

Unique id of VNF. This is unique across the graph.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vces/vce/{vnf-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns vnfcs

GET /network/vnfcs

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/vnfcs
default

Response codes found in response codes.

returns vnfc

GET /network/vnfcs/vnfc/{vnfc-name}

Tags: Network

returns vnfc
vnfc-name

Unique ID of vnfc.

 path string

application/json application/xml

200 OK

successful operation

/vnfc
default

Response codes found in response codes.

create or update an existing vnfc

PUT /network/vnfcs/vnfc/{vnfc-name}

Tags: Network

create or update an existing vnfc

application/json application/xml

vnfc object that needs to be created or updated.

/vnfc
vnfc-name

Unique ID of vnfc.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing vnfc

PATCH /network/vnfcs/vnfc/{vnfc-name}

Tags: Network

update an existing vnfc

application/json application/xml

vnfc object that needs to be updated.

/zzzz-patch-vnfc
vnfc-name

Unique ID of vnfc.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing vnfc

DELETE /network/vnfcs/vnfc/{vnfc-name}

Tags: Network

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

default

Response codes found in response codes.

returns cps

GET /network/vnfcs/vnfc/{vnfc-name}/cps

Tags: Network

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

200 OK

successful operation

/cps
default

Response codes found in response codes.

returns cp

GET /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}

Tags: Network

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

200 OK

successful operation

/cp
default

Response codes found in response codes.

create or update an existing cp

PUT /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}

Tags: Network

create or update an existing cp

application/json application/xml

cp object that needs to be created or updated.

/cp
vnfc-name

Unique ID of vnfc.

 path string
cp-instance-id

Unique ID of the connection point.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing cp

PATCH /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}

Tags: Network

update an existing cp

application/json application/xml

cp object that needs to be updated.

/zzzz-patch-cp
vnfc-name

Unique ID of vnfc.

 path string
cp-instance-id

Unique ID of the connection point.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing cp

DELETE /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv4-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv4-address-list

PUT /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv4-address-list

PATCH /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv4-address-list

DELETE /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv6-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv6-address-list

PUT /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv6-address-list

PATCH /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv6-address-list

DELETE /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
vnfc-name

Unique ID of vnfc.

 path string
cp-instance-id

Unique ID of the connection point.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv4-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv4-address-list

PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv4-address-list

PATCH /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv4-address-list

DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
vnfc-name

Unique ID of vnfc.

 path string
l3-interface-ipv4-address

IP address

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv6-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv6-address-list

PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv6-address-list

PATCH /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv6-address-list

DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
vnfc-name

Unique ID of vnfc.

 path string
l3-interface-ipv6-address

IP address

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
vnfc-name

Unique ID of vnfc.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

vnfc-name

Unique ID of vnfc.

 path string

application/json application/xml

default

Response codes found in response codes.

returns vpls-pes

GET /network/vpls-pes

Tags: Network

returns vpls-pes
equipment-name

n/a

 query string
prov-status

n/a

 query string
vlan-id-outer

n/a

 query integer
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/vpls-pes
default

Response codes found in response codes.

returns vpls-pe

GET /network/vpls-pes/vpls-pe/{equipment-name}

Tags: Network

returns vpls-pe
equipment-name path string

application/json application/xml

200 OK

successful operation

/vpls-pe
default

Response codes found in response codes.

create or update an existing vpls-pe

PUT /network/vpls-pes/vpls-pe/{equipment-name}

Tags: Network

create or update an existing vpls-pe

application/json application/xml

vpls-pe object that needs to be created or updated.

/vpls-pe
equipment-name path string

application/json application/xml

default

Response codes found in response codes.

update an existing vpls-pe

PATCH /network/vpls-pes/vpls-pe/{equipment-name}

Tags: Network

update an existing vpls-pe

application/json application/xml

vpls-pe object that needs to be updated.

/zzzz-patch-vpls-pe
equipment-name path string

application/json application/xml

default

Response codes found in response codes.

delete an existing vpls-pe

DELETE /network/vpls-pes/vpls-pe/{equipment-name}

Tags: Network

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

default

Response codes found in response codes.

returns lag-interfaces

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string
interface-type

n/a

 query string

application/json application/xml

200 OK

successful operation

/lag-interfaces
default

Response codes found in response codes.

returns lag-interface

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

Tags: Network

returns lag-interface
equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string

application/json application/xml

200 OK

successful operation

/lag-interface
default

Response codes found in response codes.

create or update an existing lag-interface

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

Tags: Network

create or update an existing lag-interface

application/json application/xml

lag-interface object that needs to be created or updated.

/lag-interface
equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing lag-interface

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

Tags: Network

update an existing lag-interface

application/json application/xml

lag-interface object that needs to be updated.

/zzzz-patch-lag-interface
equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing lag-interface

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

Tags: Network

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

default

Response codes found in response codes.

returns aggregated-ether-options

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options

Tags: Network

returns aggregated-ether-options
equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
aggregated-ether-option-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

200 OK

successful operation

/aggregated-ether-options
default

Response codes found in response codes.

returns aggregated-ether-option

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}

Tags: Network

returns aggregated-ether-option
equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
aggregated-ether-option-id

UUID - unique object identifier

 path string

application/json application/xml

200 OK

successful operation

/aggregated-ether-option
default

Response codes found in response codes.

create or update an existing aggregated-ether-option

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}

Tags: Network

create or update an existing aggregated-ether-option

application/json application/xml

aggregated-ether-option object that needs to be created or updated.

/aggregated-ether-option
equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
aggregated-ether-option-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing aggregated-ether-option

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}

Tags: Network

update an existing aggregated-ether-option

application/json application/xml

aggregated-ether-option object that needs to be updated.

/zzzz-patch-aggregated-ether-option
equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
aggregated-ether-option-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing aggregated-ether-option

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}

Tags: Network

delete an existing aggregated-ether-option

application/json application/xml

equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
aggregated-ether-option-id

UUID - unique object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

returns lacps

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps

Tags: Network

returns lacps
equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
aggregated-ether-option-id

UUID - unique object identifier

 path string
lacp-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

200 OK

successful operation

/lacps
default

Response codes found in response codes.

returns lacp

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}

Tags: Network

returns lacp
equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
aggregated-ether-option-id

UUID - unique object identifier

 path string
lacp-id

UUID- unique object identifier

 path string

application/json application/xml

200 OK

successful operation

/lacp
default

Response codes found in response codes.

create or update an existing lacp

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}

Tags: Network

create or update an existing lacp

application/json application/xml

lacp object that needs to be created or updated.

/lacp
equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
aggregated-ether-option-id

UUID - unique object identifier

 path string
lacp-id

UUID- unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing lacp

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}

Tags: Network

update an existing lacp

application/json application/xml

lacp object that needs to be updated.

/zzzz-patch-lacp
equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
aggregated-ether-option-id

UUID - unique object identifier

 path string
lacp-id

UUID- unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing lacp

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}

Tags: Network

delete an existing lacp

application/json application/xml

equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
aggregated-ether-option-id

UUID - unique object identifier

 path string
lacp-id

UUID- unique object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
aggregated-ether-option-id

UUID - unique object identifier

 path string
lacp-id

UUID- unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/lacps/lacp/{lacp-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
aggregated-ether-option-id

UUID - unique object identifier

 path string
lacp-id

UUID- unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
aggregated-ether-option-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/aggregated-ether-options/aggregated-ether-option/{aggregated-ether-option-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
aggregated-ether-option-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

returns esis

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/esis

Tags: Network

returns esis
equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
esi-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

200 OK

successful operation

/esis
default

Response codes found in response codes.

returns esi

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}

Tags: Network

returns esi
equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
esi-id

object identifier

 path string

application/json application/xml

200 OK

successful operation

/esi
default

Response codes found in response codes.

create or update an existing esi

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}

Tags: Network

create or update an existing esi

application/json application/xml

esi object that needs to be created or updated.

/esi
equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
esi-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing esi

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}

Tags: Network

update an existing esi

application/json application/xml

esi object that needs to be updated.

/zzzz-patch-esi
equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
esi-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing esi

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}

Tags: Network

delete an existing esi

application/json application/xml

equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
esi-id

object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
esi-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/esis/esi/{esi-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
esi-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

returns l-interfaces

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/l-interfaces
default

Response codes found in response codes.

returns l-interface

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

Tags: Network

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

200 OK

successful operation

/l-interface
default

Response codes found in response codes.

create or update an existing l-interface

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

Tags: Network

create or update an existing l-interface

application/json application/xml

l-interface object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing l-interface

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

Tags: Network

update an existing l-interface

application/json application/xml

l-interface object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l-interface

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv4-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv4-address-list

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv4-address-list

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv4-address-list

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv6-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv6-address-list

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv6-address-list

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv6-address-list

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns lcmp-unreachables

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables

Tags: Network

returns lcmp-unreachables
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
lcmp-unreachable-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

200 OK

successful operation

/lcmp-unreachables
default

Response codes found in response codes.

returns lcmp-unreachable

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: Network

returns lcmp-unreachable
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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

200 OK

successful operation

/lcmp-unreachable
default

Response codes found in response codes.

create or update an existing lcmp-unreachable

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: Network

create or update an existing lcmp-unreachable

application/json application/xml

lcmp-unreachable object that needs to be created or updated.

/lcmp-unreachable
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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing lcmp-unreachable

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: Network

update an existing lcmp-unreachable

application/json application/xml

lcmp-unreachable object that needs to be updated.

/zzzz-patch-lcmp-unreachable
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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing lcmp-unreachable

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: Network

delete an existing lcmp-unreachable

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
lcmp-unreachable-id

object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

Tags: Network

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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns sriov-vfs

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string
neutron-network-id

n/a

 query string

application/json application/xml

200 OK

successful operation

/sriov-vfs
default

Response codes found in response codes.

returns sriov-vf

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

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

200 OK

successful operation

/sriov-vf
default

Response codes found in response codes.

create or update an existing sriov-vf

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

create or update an existing sriov-vf

application/json application/xml

sriov-vf object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing sriov-vf

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

update an existing sriov-vf

application/json application/xml

sriov-vf object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing sriov-vf

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns temporary-parameter-lists

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists

Tags: Network

returns temporary-parameter-lists
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
temporary-parameter-list-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

200 OK

successful operation

/temporary-parameter-lists
default

Response codes found in response codes.

returns temporary-parameter-list

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

returns temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

200 OK

successful operation

/temporary-parameter-list
default

Response codes found in response codes.

create or update an existing temporary-parameter-list

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

create or update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be created or updated.

/temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing temporary-parameter-list

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be updated.

/zzzz-patch-temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing temporary-parameter-list

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

delete an existing temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: Network

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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

returns vlans

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans

Tags: Network

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
vlan-id-outer

n/a

 query integer
vlan-type

n/a

 query string
vpn-key

n/a

 query string
orchestration-status

n/a

 query string
prov-status

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

200 OK

successful operation

/vlans
default

Response codes found in response codes.

returns vlan

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

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

200 OK

successful operation

/vlan
default

Response codes found in response codes.

create or update an existing vlan

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

create or update an existing vlan

application/json application/xml

vlan object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing vlan

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

update an existing vlan

application/json application/xml

vlan object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing vlan

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv4-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv4-address-list

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv4-address-list

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv4-address-list

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv6-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv6-address-list

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv6-address-list

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv6-address-list

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv4-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv4-address-list

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv4-address-list

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv4-address-list

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv6-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv6-address-list

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv6-address-list

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv6-address-list

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns temporary-parameter-lists

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists

Tags: Network

returns temporary-parameter-lists
equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
temporary-parameter-list-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

200 OK

successful operation

/temporary-parameter-lists
default

Response codes found in response codes.

returns temporary-parameter-list

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

returns temporary-parameter-list
equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

200 OK

successful operation

/temporary-parameter-list
default

Response codes found in response codes.

create or update an existing temporary-parameter-list

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

create or update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be created or updated.

/temporary-parameter-list
equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing temporary-parameter-list

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be updated.

/zzzz-patch-temporary-parameter-list
equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing temporary-parameter-list

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

delete an existing temporary-parameter-list

application/json application/xml

equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

returns p-interfaces

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces

Tags: Network

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
interface-type

n/a

 query string
prov-status

n/a

 query string
inv-status

n/a

 query string
interface-function

n/a

 query string
macaddr

n/a

 query string
network-ref

n/a

 query string
operational-status

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

200 OK

successful operation

/p-interfaces
default

Response codes found in response codes.

returns p-interface

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

Tags: Network

returns p-interface
equipment-name path string
interface-name

Name that identifies the physical interface

 path string

application/json application/xml

200 OK

successful operation

/p-interface
default

Response codes found in response codes.

create or update an existing p-interface

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

Tags: Network

create or update an existing p-interface

application/json application/xml

p-interface object that needs to be created or updated.

/p-interface
equipment-name path string
interface-name

Name that identifies the physical interface

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing p-interface

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

Tags: Network

update an existing p-interface

application/json application/xml

p-interface object that needs to be updated.

/zzzz-patch-p-interface
equipment-name path string
interface-name

Name that identifies the physical interface

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing p-interface

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

Tags: Network

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

default

Response codes found in response codes.

returns activities

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/activities

Tags: Network

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

200 OK

successful operation

/activities
default

Response codes found in response codes.

returns activity

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}

Tags: Network

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

200 OK

successful operation

/activity
default

Response codes found in response codes.

create or update an existing activity

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}

Tags: Network

create or update an existing activity

application/json application/xml

activity object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing activity

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}

Tags: Network

update an existing activity

application/json application/xml

activity object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing activity

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}

Tags: Network

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

default

Response codes found in response codes.

returns activity-states

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states

Tags: Network

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

200 OK

successful operation

/activity-states
default

Response codes found in response codes.

returns activity-state

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

Tags: Network

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

200 OK

successful operation

/activity-state
default

Response codes found in response codes.

create or update an existing activity-state

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

Tags: Network

create or update an existing activity-state

application/json application/xml

activity-state object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing activity-state

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

Tags: Network

update an existing activity-state

application/json application/xml

activity-state object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing activity-state

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/activity-states/activity-state/{state-order}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/activities/activity/{activity-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns bandwidth-attributes

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes

Tags: Network

returns bandwidth-attributes
equipment-name path string
interface-name

Name that identifies the physical interface

 path string
bwa-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

200 OK

successful operation

/bandwidth-attributes
default

Response codes found in response codes.

returns bandwidth-attribute

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}

Tags: Network

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

200 OK

successful operation

/bandwidth-attribute
default

Response codes found in response codes.

create or update an existing bandwidth-attribute

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}

Tags: Network

create or update an existing bandwidth-attribute

application/json application/xml

bandwidth-attribute object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing bandwidth-attribute

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}

Tags: Network

update an existing bandwidth-attribute

application/json application/xml

bandwidth-attribute object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing bandwidth-attribute

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}

Tags: Network

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

default

Response codes found in response codes.

returns available-bandwidth-map

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/available-bandwidth-map
default

Response codes found in response codes.

returns available-bandwidth

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}

Tags: Network

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

200 OK

successful operation

/available-bandwidth
default

Response codes found in response codes.

create or update an existing available-bandwidth

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}

Tags: Network

create or update an existing available-bandwidth

application/json application/xml

available-bandwidth object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing available-bandwidth

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}

Tags: Network

update an existing available-bandwidth

application/json application/xml

available-bandwidth object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing available-bandwidth

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/available-bandwidth-map/available-bandwidth/{ab-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/bandwidth-attributes/bandwidth-attribute/{bwa-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns gig-ether-options

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/gig-ether-options

Tags: Network

returns gig-ether-options
equipment-name path string
interface-name

Name that identifies the physical interface

 path string
gig-ether-option-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

200 OK

successful operation

/gig-ether-options
default

Response codes found in response codes.

returns gig-ether-option

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}

Tags: Network

returns gig-ether-option
equipment-name path string
interface-name

Name that identifies the physical interface

 path string
gig-ether-option-id

UUID - unique object identifier

 path string

application/json application/xml

200 OK

successful operation

/gig-ether-option
default

Response codes found in response codes.

create or update an existing gig-ether-option

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}

Tags: Network

create or update an existing gig-ether-option

application/json application/xml

gig-ether-option object that needs to be created or updated.

/gig-ether-option
equipment-name path string
interface-name

Name that identifies the physical interface

 path string
gig-ether-option-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing gig-ether-option

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}

Tags: Network

update an existing gig-ether-option

application/json application/xml

gig-ether-option object that needs to be updated.

/zzzz-patch-gig-ether-option
equipment-name path string
interface-name

Name that identifies the physical interface

 path string
gig-ether-option-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing gig-ether-option

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}

Tags: Network

delete an existing gig-ether-option

application/json application/xml

equipment-name path string
interface-name

Name that identifies the physical interface

 path string
gig-ether-option-id

UUID - unique object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
equipment-name path string
interface-name

Name that identifies the physical interface

 path string
gig-ether-option-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/gig-ether-options/gig-ether-option/{gig-ether-option-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

equipment-name path string
interface-name

Name that identifies the physical interface

 path string
gig-ether-option-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

returns hold-timers

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/hold-timers

Tags: Network

returns hold-timers
equipment-name path string
interface-name

Name that identifies the physical interface

 path string
hold-timer-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

200 OK

successful operation

/hold-timers
default

Response codes found in response codes.

returns hold-timer

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/hold-timers/hold-timer/{hold-timer-id}

Tags: Network

returns hold-timer
equipment-name path string
interface-name

Name that identifies the physical interface

 path string
hold-timer-id

UUID - unique object identifier

 path string

application/json application/xml

200 OK

successful operation

/hold-timer
default

Response codes found in response codes.

create or update an existing hold-timer

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/hold-timers/hold-timer/{hold-timer-id}

Tags: Network

create or update an existing hold-timer

application/json application/xml

hold-timer object that needs to be created or updated.

/hold-timer
equipment-name path string
interface-name

Name that identifies the physical interface

 path string
hold-timer-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing hold-timer

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/hold-timers/hold-timer/{hold-timer-id}

Tags: Network

update an existing hold-timer

application/json application/xml

hold-timer object that needs to be updated.

/zzzz-patch-hold-timer
equipment-name path string
interface-name

Name that identifies the physical interface

 path string
hold-timer-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing hold-timer

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/hold-timers/hold-timer/{hold-timer-id}

Tags: Network

delete an existing hold-timer

application/json application/xml

equipment-name path string
interface-name

Name that identifies the physical interface

 path string
hold-timer-id

UUID - unique object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/hold-timers/hold-timer/{hold-timer-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
equipment-name path string
interface-name

Name that identifies the physical interface

 path string
hold-timer-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/hold-timers/hold-timer/{hold-timer-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

equipment-name path string
interface-name

Name that identifies the physical interface

 path string
hold-timer-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

returns l-interfaces

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/l-interfaces
default

Response codes found in response codes.

returns l-interface

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

Tags: Network

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

200 OK

successful operation

/l-interface
default

Response codes found in response codes.

create or update an existing l-interface

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

Tags: Network

create or update an existing l-interface

application/json application/xml

l-interface object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing l-interface

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

Tags: Network

update an existing l-interface

application/json application/xml

l-interface object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l-interface

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv4-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv4-address-list

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv4-address-list

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv4-address-list

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv6-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv6-address-list

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv6-address-list

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv6-address-list

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns lcmp-unreachables

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables

Tags: Network

returns lcmp-unreachables
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
lcmp-unreachable-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

200 OK

successful operation

/lcmp-unreachables
default

Response codes found in response codes.

returns lcmp-unreachable

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: Network

returns lcmp-unreachable
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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

200 OK

successful operation

/lcmp-unreachable
default

Response codes found in response codes.

create or update an existing lcmp-unreachable

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: Network

create or update an existing lcmp-unreachable

application/json application/xml

lcmp-unreachable object that needs to be created or updated.

/lcmp-unreachable
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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing lcmp-unreachable

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: Network

update an existing lcmp-unreachable

application/json application/xml

lcmp-unreachable object that needs to be updated.

/zzzz-patch-lcmp-unreachable
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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing lcmp-unreachable

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}

Tags: Network

delete an existing lcmp-unreachable

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
lcmp-unreachable-id

object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/lcmp-unreachables/lcmp-unreachable/{lcmp-unreachable-id}/relationship-list/relationship

Tags: Network

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
lcmp-unreachable-id

object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns sriov-vfs

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string
neutron-network-id

n/a

 query string

application/json application/xml

200 OK

successful operation

/sriov-vfs
default

Response codes found in response codes.

returns sriov-vf

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

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

200 OK

successful operation

/sriov-vf
default

Response codes found in response codes.

create or update an existing sriov-vf

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

create or update an existing sriov-vf

application/json application/xml

sriov-vf object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing sriov-vf

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

update an existing sriov-vf

application/json application/xml

sriov-vf object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing sriov-vf

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns temporary-parameter-lists

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists

Tags: Network

returns temporary-parameter-lists
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
temporary-parameter-list-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

200 OK

successful operation

/temporary-parameter-lists
default

Response codes found in response codes.

returns temporary-parameter-list

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

returns temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

200 OK

successful operation

/temporary-parameter-list
default

Response codes found in response codes.

create or update an existing temporary-parameter-list

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

create or update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be created or updated.

/temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing temporary-parameter-list

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be updated.

/zzzz-patch-temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing temporary-parameter-list

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

delete an existing temporary-parameter-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
temporary-parameter-list-id

UUID - unique object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: Network

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
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

returns vlans

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans

Tags: Network

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
vlan-id-outer

n/a

 query integer
vlan-type

n/a

 query string
vpn-key

n/a

 query string
orchestration-status

n/a

 query string
prov-status

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

200 OK

successful operation

/vlans
default

Response codes found in response codes.

returns vlan

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

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

200 OK

successful operation

/vlan
default

Response codes found in response codes.

create or update an existing vlan

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

create or update an existing vlan

application/json application/xml

vlan object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing vlan

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

update an existing vlan

application/json application/xml

vlan object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing vlan

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv4-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv4-address-list

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv4-address-list

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv4-address-list

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv6-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv6-address-list

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv6-address-list

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv6-address-list

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{l-interface.interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv4-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv4-address-list

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv4-address-list

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv4-address-list

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

200 OK

successful operation

/l3-interface-ipv6-address-list
default

Response codes found in response codes.

create or update an existing l3-interface-ipv6-address-list

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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.

/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

default

Response codes found in response codes.

update an existing l3-interface-ipv6-address-list

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing l3-interface-ipv6-address-list

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
equipment-name path string
interface-name

Name that identifies the physical interface

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns sriov-pfs

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs

Tags: Network

returns sriov-pfs
equipment-name path string
interface-name

Name that identifies the physical interface

 path string
pf-pci-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

200 OK

successful operation

/sriov-pfs
default

Response codes found in response codes.

returns sriov-pf

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

Tags: Network

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

200 OK

successful operation

/sriov-pf
default

Response codes found in response codes.

create or update an existing sriov-pf

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

Tags: Network

create or update an existing sriov-pf

application/json application/xml

sriov-pf object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing sriov-pf

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

Tags: Network

update an existing sriov-pf

application/json application/xml

sriov-pf object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing sriov-pf

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns temporary-parameter-lists

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists

Tags: Network

returns temporary-parameter-lists
equipment-name path string
interface-name

Name that identifies the physical interface

 path string
temporary-parameter-list-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

200 OK

successful operation

/temporary-parameter-lists
default

Response codes found in response codes.

returns temporary-parameter-list

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

returns temporary-parameter-list
equipment-name path string
interface-name

Name that identifies the physical interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

200 OK

successful operation

/temporary-parameter-list
default

Response codes found in response codes.

create or update an existing temporary-parameter-list

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

create or update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be created or updated.

/temporary-parameter-list
equipment-name path string
interface-name

Name that identifies the physical interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing temporary-parameter-list

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

update an existing temporary-parameter-list

application/json application/xml

temporary-parameter-list object that needs to be updated.

/zzzz-patch-temporary-parameter-list
equipment-name path string
interface-name

Name that identifies the physical interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing temporary-parameter-list

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}

Tags: Network

delete an existing temporary-parameter-list

application/json application/xml

equipment-name path string
interface-name

Name that identifies the physical interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
equipment-name path string
interface-name

Name that identifies the physical interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/temporary-parameter-lists/temporary-parameter-list/{temporary-parameter-list-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

equipment-name path string
interface-name

Name that identifies the physical interface

 path string
temporary-parameter-list-id

UUID - unique object identifier

 path string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
equipment-name path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

equipment-name path string

application/json application/xml

default

Response codes found in response codes.

returns vpn-bindings

GET /network/vpn-bindings

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/vpn-bindings
default

Response codes found in response codes.

returns vpn-binding

GET /network/vpn-bindings/vpn-binding/{vpn-id}

Tags: Network

returns vpn-binding
vpn-id

VPN ID, globally unique within A&AI

 path string

application/json application/xml

200 OK

successful operation

/vpn-binding
default

Response codes found in response codes.

create or update an existing vpn-binding

PUT /network/vpn-bindings/vpn-binding/{vpn-id}

Tags: Network

create or update an existing vpn-binding

application/json application/xml

vpn-binding object that needs to be created or updated.

/vpn-binding
vpn-id

VPN ID, globally unique within A&AI

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing vpn-binding

PATCH /network/vpn-bindings/vpn-binding/{vpn-id}

Tags: Network

update an existing vpn-binding

application/json application/xml

vpn-binding object that needs to be updated.

/zzzz-patch-vpn-binding
vpn-id

VPN ID, globally unique within A&AI

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing vpn-binding

DELETE /network/vpn-bindings/vpn-binding/{vpn-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
vpn-id

VPN ID, globally unique within A&AI

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

vpn-id

VPN ID, globally unique within A&AI

 path string

application/json application/xml

default

Response codes found in response codes.

returns route-targets

GET /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets

Tags: Network

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

200 OK

successful operation

/route-targets
default

Response codes found in response codes.

returns route-target

GET /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

Tags: Network

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

200 OK

successful operation

/route-target
default

Response codes found in response codes.

create or update an existing route-target

PUT /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

Tags: Network

create or update an existing route-target

application/json application/xml

route-target object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing route-target

PATCH /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

Tags: Network

update an existing route-target

application/json application/xml

route-target object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing route-target

DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns wan-port-configs

GET /network/wan-port-configs

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/wan-port-configs
default

Response codes found in response codes.

returns wan-port-config

GET /network/wan-port-configs/wan-port-config/{wan-port-config-id}

Tags: Network

returns wan-port-config
wan-port-config-id

Uniquely identifies this wan-port-config by id

 path string

application/json application/xml

200 OK

successful operation

/wan-port-config
default

Response codes found in response codes.

create or update an existing wan-port-config

PUT /network/wan-port-configs/wan-port-config/{wan-port-config-id}

Tags: Network

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
wan-port-config-id

Uniquely identifies this wan-port-config by id

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing wan-port-config

PATCH /network/wan-port-configs/wan-port-config/{wan-port-config-id}

Tags: Network

update an existing wan-port-config

application/json application/xml

wan-port-config object that needs to be updated.

/zzzz-patch-wan-port-config
wan-port-config-id

Uniquely identifies this wan-port-config by id

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing wan-port-config

DELETE /network/wan-port-configs/wan-port-config/{wan-port-config-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/wan-port-configs/wan-port-config/{wan-port-config-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
wan-port-config-id

Uniquely identifies this wan-port-config by id

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/wan-port-configs/wan-port-config/{wan-port-config-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns zones

GET /network/zones

Tags: Network

returns zones
zone-id

n/a

 query string
design-type

n/a

 query string
zone-context

n/a

 query string
zone-number

n/a

 query integer
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/zones
default

Response codes found in response codes.

returns zone

GET /network/zones/zone/{zone-id}

Tags: Network

returns zone
zone-id

Code assigned by AIC to the zone

 path string

application/json application/xml

200 OK

successful operation

/zone
default

Response codes found in response codes.

create or update an existing zone

PUT /network/zones/zone/{zone-id}

Tags: Network

create or update an existing zone

application/json application/xml

zone object that needs to be created or updated.

/zone
zone-id

Code assigned by AIC to the zone

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing zone

PATCH /network/zones/zone/{zone-id}

Tags: Network

update an existing zone

application/json application/xml

zone object that needs to be updated.

/zzzz-patch-zone
zone-id

Code assigned by AIC to the zone

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing zone

DELETE /network/zones/zone/{zone-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/zones/zone/{zone-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
zone-id

Code assigned by AIC to the zone

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/zones/zone/{zone-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

zone-id

Code assigned by AIC to the zone

 path string

application/json application/xml

default

Response codes found in response codes.

returns subnets

GET /network/zones/zone/{zone-id}/subnets

Tags: Network

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
neutron-subnet-id

n/a

 query string
orchestration-status

n/a

 query string
subnet-type

n/a

 query string
subnet-function

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

200 OK

successful operation

/subnets
default

Response codes found in response codes.

returns subnet

GET /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}

Tags: Network

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

200 OK

successful operation

/subnet
default

Response codes found in response codes.

create or update an existing subnet

PUT /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}

Tags: Network

create or update an existing subnet

application/json application/xml

subnet object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing subnet

PATCH /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}

Tags: Network

update an existing subnet

application/json application/xml

subnet object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing subnet

DELETE /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}

Tags: Network

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

default

Response codes found in response codes.

returns bgp-neighbors

GET /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/bgp-neighbors

Tags: Network

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
prov-status

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

200 OK

successful operation

/bgp-neighbors
default

Response codes found in response codes.

returns bgp-neighbor

GET /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

Tags: Network

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

200 OK

successful operation

/bgp-neighbor
default

Response codes found in response codes.

create or update an existing bgp-neighbor

PUT /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

Tags: Network

create or update an existing bgp-neighbor

application/json application/xml

bgp-neighbor object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing bgp-neighbor

PATCH /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

Tags: Network

update an existing bgp-neighbor

application/json application/xml

bgp-neighbor object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing bgp-neighbor

DELETE /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}

Tags: Network

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

default

Response codes found in response codes.

returns address-families

GET /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families

Tags: Network

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/address-families
default

Response codes found in response codes.

returns address-family

GET /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

Tags: Network

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

200 OK

successful operation

/address-family
default

Response codes found in response codes.

create or update an existing address-family

PUT /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

Tags: Network

create or update an existing address-family

application/json application/xml

address-family object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing address-family

PATCH /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

Tags: Network

update an existing address-family

application/json application/xml

address-family object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing address-family

DELETE /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/address-families/address-family/{address-family-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/bgp-neighbors/bgp-neighbor/{bgp-neighbor-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns host-routes

GET /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/host-routes

Tags: Network

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
next-hop

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

200 OK

successful operation

/host-routes
default

Response codes found in response codes.

returns host-route

GET /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

Tags: Network

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

200 OK

successful operation

/host-route
default

Response codes found in response codes.

create or update an existing host-route

PUT /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

Tags: Network

create or update an existing host-route

application/json application/xml

host-route object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing host-route

PATCH /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

Tags: Network

update an existing host-route

application/json application/xml

host-route object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing host-route

DELETE /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

Tags: Network

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns ip-address-list

GET /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/ip-address-list/{ip-address}

Tags: Network

returns ip-address-list
zone-id

Code assigned by AIC to the zone

 path string
subnet-id

Subnet ID, should be UUID.

 path string
ip-address

IP address

 path string

application/json application/xml

200 OK

successful operation

/ip-address-list
default

Response codes found in response codes.

create or update an existing ip-address-list

PUT /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/ip-address-list/{ip-address}

Tags: Network

create or update an existing ip-address-list

application/json application/xml

ip-address-list object that needs to be created or updated.

/ip-address-list
zone-id

Code assigned by AIC to the zone

 path string
subnet-id

Subnet ID, should be UUID.

 path string
ip-address

IP address

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing ip-address-list

PATCH /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/ip-address-list/{ip-address}

Tags: Network

update an existing ip-address-list

application/json application/xml

ip-address-list object that needs to be updated.

/zzzz-patch-ip-address-list
zone-id

Code assigned by AIC to the zone

 path string
subnet-id

Subnet ID, should be UUID.

 path string
ip-address

IP address

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing ip-address-list

DELETE /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/ip-address-list/{ip-address}

Tags: Network

delete an existing ip-address-list

application/json application/xml

zone-id

Code assigned by AIC to the zone

 path string
subnet-id

Subnet ID, should be UUID.

 path string
ip-address

IP address

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/ip-address-list/{ip-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
zone-id

Code assigned by AIC to the zone

 path string
subnet-id

Subnet ID, should be UUID.

 path string
ip-address

IP address

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/ip-address-list/{ip-address}/relationship-list/relationship

Tags: Network

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
ip-address

IP address

 path string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
zone-id

Code assigned by AIC to the zone

 path string
subnet-id

Subnet ID, should be UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/zones/zone/{zone-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

Tags: Network

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

default

Response codes found in response codes.

returns vlan-ranges

GET /network/zones/zone/{zone-id}/vlan-ranges

Tags: Network

returns vlan-ranges
zone-id

Code assigned by AIC to the zone

 path string
vlan-range-id

n/a

 query string
vlan-type

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

200 OK

successful operation

/vlan-ranges
default

Response codes found in response codes.

returns vlan-range

GET /network/zones/zone/{zone-id}/vlan-ranges/vlan-range/{vlan-range-id}

Tags: Network

returns vlan-range
zone-id

Code assigned by AIC to the zone

 path string
vlan-range-id

vlan id in range UUID.

 path string

application/json application/xml

200 OK

successful operation

/vlan-range
default

Response codes found in response codes.

create or update an existing vlan-range

PUT /network/zones/zone/{zone-id}/vlan-ranges/vlan-range/{vlan-range-id}

Tags: Network

create or update an existing vlan-range

application/json application/xml

vlan-range object that needs to be created or updated.

/vlan-range
zone-id

Code assigned by AIC to the zone

 path string
vlan-range-id

vlan id in range UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing vlan-range

PATCH /network/zones/zone/{zone-id}/vlan-ranges/vlan-range/{vlan-range-id}

Tags: Network

update an existing vlan-range

application/json application/xml

vlan-range object that needs to be updated.

/zzzz-patch-vlan-range
zone-id

Code assigned by AIC to the zone

 path string
vlan-range-id

vlan id in range UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing vlan-range

DELETE /network/zones/zone/{zone-id}/vlan-ranges/vlan-range/{vlan-range-id}

Tags: Network

delete an existing vlan-range

application/json application/xml

zone-id

Code assigned by AIC to the zone

 path string
vlan-range-id

vlan id in range UUID.

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/zones/zone/{zone-id}/vlan-ranges/vlan-range/{vlan-range-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
zone-id

Code assigned by AIC to the zone

 path string
vlan-range-id

vlan id in range UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/zones/zone/{zone-id}/vlan-ranges/vlan-range/{vlan-range-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

zone-id

Code assigned by AIC to the zone

 path string
vlan-range-id

vlan id in range UUID.

 path string

application/json application/xml

default

Response codes found in response codes.

returns vlan-tags

GET /network/zones/zone/{zone-id}/vlan-ranges/vlan-range/{vlan-range-id}/vlan-tags

Tags: Network

returns vlan-tags
zone-id

Code assigned by AIC to the zone

 path string
vlan-range-id

vlan id in range UUID.

 path string
vlan-id-inner

n/a

 query integer
vlan-id-outer

n/a

 query integer
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/vlan-tags
default

Response codes found in response codes.

returns vlan-tag

GET /network/zones/zone/{zone-id}/vlan-ranges/vlan-range/{vlan-range-id}/vlan-tags/vlan-tag/{vlan-tag-id}

Tags: Network

returns vlan-tag
zone-id

Code assigned by AIC to the zone

 path string
vlan-range-id

vlan id in range UUID.

 path string
vlan-tag-id

Vlan Tag Id

 path string

application/json application/xml

200 OK

successful operation

/vlan-tag
default

Response codes found in response codes.

create or update an existing vlan-tag

PUT /network/zones/zone/{zone-id}/vlan-ranges/vlan-range/{vlan-range-id}/vlan-tags/vlan-tag/{vlan-tag-id}

Tags: Network

create or update an existing vlan-tag

application/json application/xml

vlan-tag object that needs to be created or updated.

/vlan-tag
zone-id

Code assigned by AIC to the zone

 path string
vlan-range-id

vlan id in range UUID.

 path string
vlan-tag-id

Vlan Tag Id

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing vlan-tag

PATCH /network/zones/zone/{zone-id}/vlan-ranges/vlan-range/{vlan-range-id}/vlan-tags/vlan-tag/{vlan-tag-id}

Tags: Network

update an existing vlan-tag

application/json application/xml

vlan-tag object that needs to be updated.

/zzzz-patch-vlan-tag
zone-id

Code assigned by AIC to the zone

 path string
vlan-range-id

vlan id in range UUID.

 path string
vlan-tag-id

Vlan Tag Id

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing vlan-tag

DELETE /network/zones/zone/{zone-id}/vlan-ranges/vlan-range/{vlan-range-id}/vlan-tags/vlan-tag/{vlan-tag-id}

Tags: Network

delete an existing vlan-tag

application/json application/xml

zone-id

Code assigned by AIC to the zone

 path string
vlan-range-id

vlan id in range UUID.

 path string
vlan-tag-id

Vlan Tag Id

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/zones/zone/{zone-id}/vlan-ranges/vlan-range/{vlan-range-id}/vlan-tags/vlan-tag/{vlan-tag-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
zone-id

Code assigned by AIC to the zone

 path string
vlan-range-id

vlan id in range UUID.

 path string
vlan-tag-id

Vlan Tag Id

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/zones/zone/{zone-id}/vlan-ranges/vlan-range/{vlan-range-id}/vlan-tags/vlan-tag/{vlan-tag-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

zone-id

Code assigned by AIC to the zone

 path string
vlan-range-id

vlan id in range UUID.

 path string
vlan-tag-id

Vlan Tag Id

 path string

application/json application/xml

default

Response codes found in response codes.

returns models

GET /service-design-and-creation/models

Tags: ServiceDesignAndCreation

returns models
model-invariant-id

n/a

 query string
model-type

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

200 OK

successful operation

/models
default

Response codes found in response codes.

returns model

GET /service-design-and-creation/models/model/{model-invariant-id}

Tags: ServiceDesignAndCreation

returns model
model-invariant-id

Unique identifier corresponding to the main definition of a model in ASDC

 path string

application/json application/xml

200 OK

successful operation

/model
default

Response codes found in response codes.

create or update an existing model

PUT /service-design-and-creation/models/model/{model-invariant-id}

Tags: ServiceDesignAndCreation

create or update an existing model

application/json application/xml

model object that needs to be created or updated.

/model
model-invariant-id

Unique identifier corresponding to the main definition of a model in ASDC

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing model

PATCH /service-design-and-creation/models/model/{model-invariant-id}

Tags: ServiceDesignAndCreation

update an existing model

application/json application/xml

model object that needs to be updated.

/zzzz-patch-model
model-invariant-id

Unique identifier corresponding to the main definition of a model in ASDC

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing model

DELETE /service-design-and-creation/models/model/{model-invariant-id}

Tags: ServiceDesignAndCreation

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

default

Response codes found in response codes.

returns model-vers

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers

Tags: ServiceDesignAndCreation

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/model-vers
default

Response codes found in response codes.

returns model-ver

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

Tags: ServiceDesignAndCreation

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

200 OK

successful operation

/model-ver
default

Response codes found in response codes.

create or update an existing model-ver

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

Tags: ServiceDesignAndCreation

create or update an existing model-ver

application/json application/xml

model-ver object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing model-ver

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

Tags: ServiceDesignAndCreation

update an existing model-ver

application/json application/xml

model-ver object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing model-ver

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

Tags: ServiceDesignAndCreation

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

default

Response codes found in response codes.

returns metadata

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata

Tags: ServiceDesignAndCreation

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/metadata
default

Response codes found in response codes.

returns metadatum

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

Tags: ServiceDesignAndCreation

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

200 OK

successful operation

/metadatum
default

Response codes found in response codes.

create or update an existing metadatum

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

Tags: ServiceDesignAndCreation

create or update an existing metadatum

application/json application/xml

metadatum object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing metadatum

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

Tags: ServiceDesignAndCreation

update an existing metadatum

application/json application/xml

metadatum object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing metadatum

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

Tags: ServiceDesignAndCreation

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

default

Response codes found in response codes.

returns model-elements

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements

Tags: ServiceDesignAndCreation

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/model-elements
default

Response codes found in response codes.

returns model-element

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}

Tags: ServiceDesignAndCreation

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

200 OK

successful operation

/model-element
default

Response codes found in response codes.

create or update an existing model-element

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}

Tags: ServiceDesignAndCreation

create or update an existing model-element

application/json application/xml

model-element object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing model-element

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}

Tags: ServiceDesignAndCreation

update an existing model-element

application/json application/xml

model-element object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing model-element

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}

Tags: ServiceDesignAndCreation

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

default

Response codes found in response codes.

returns model-constraints

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints

Tags: ServiceDesignAndCreation

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/model-constraints
default

Response codes found in response codes.

returns model-constraint

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

Tags: ServiceDesignAndCreation

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

200 OK

successful operation

/model-constraint
default

Response codes found in response codes.

create or update an existing model-constraint

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

Tags: ServiceDesignAndCreation

create or update an existing model-constraint

application/json application/xml

model-constraint object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing model-constraint

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

Tags: ServiceDesignAndCreation

update an existing model-constraint

application/json application/xml

model-constraint object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing model-constraint

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

Tags: ServiceDesignAndCreation

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

default

Response codes found in response codes.

returns constrained-element-sets

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets

Tags: ServiceDesignAndCreation

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/constrained-element-sets
default

Response codes found in response codes.

returns constrained-element-set

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

Tags: ServiceDesignAndCreation

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

200 OK

successful operation

/constrained-element-set
default

Response codes found in response codes.

create or update an existing constrained-element-set

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

Tags: ServiceDesignAndCreation

create or update an existing constrained-element-set

application/json application/xml

constrained-element-set object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing constrained-element-set

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

Tags: ServiceDesignAndCreation

update an existing constrained-element-set

application/json application/xml

constrained-element-set object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing constrained-element-set

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

Tags: ServiceDesignAndCreation

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

default

Response codes found in response codes.

returns element-choice-sets

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets

Tags: ServiceDesignAndCreation

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/element-choice-sets
default

Response codes found in response codes.

returns element-choice-set

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

Tags: ServiceDesignAndCreation

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

200 OK

successful operation

/element-choice-set
default

Response codes found in response codes.

create or update an existing element-choice-set

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

Tags: ServiceDesignAndCreation

create or update an existing element-choice-set

application/json application/xml

element-choice-set object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing element-choice-set

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

Tags: ServiceDesignAndCreation

update an existing element-choice-set

application/json application/xml

element-choice-set object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing element-choice-set

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

Tags: ServiceDesignAndCreation

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship

Tags: ServiceDesignAndCreation

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship

Tags: ServiceDesignAndCreation

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/relationship-list/relationship

Tags: ServiceDesignAndCreation

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/relationship-list/relationship

Tags: ServiceDesignAndCreation

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship

Tags: ServiceDesignAndCreation

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship

Tags: ServiceDesignAndCreation

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship

Tags: ServiceDesignAndCreation

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship

Tags: ServiceDesignAndCreation

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship

Tags: ServiceDesignAndCreation

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
model-invariant-id

Unique identifier corresponding to the main definition of a model in ASDC

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship

Tags: ServiceDesignAndCreation

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

default

Response codes found in response codes.

returns named-queries

GET /service-design-and-creation/named-queries

Tags: ServiceDesignAndCreation

returns named-queries
named-query-uuid

n/a

 query string
named-query-name

n/a

 query string

application/json application/xml

200 OK

successful operation

/named-queries
default

Response codes found in response codes.

returns named-query

GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}

Tags: ServiceDesignAndCreation

returns named-query
named-query-uuid path string

application/json application/xml

200 OK

successful operation

/named-query
default

Response codes found in response codes.

create or update an existing named-query

PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}

Tags: ServiceDesignAndCreation

create or update an existing named-query

application/json application/xml

named-query object that needs to be created or updated.

/named-query
named-query-uuid path string

application/json application/xml

default

Response codes found in response codes.

update an existing named-query

PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}

Tags: ServiceDesignAndCreation

update an existing named-query

application/json application/xml

named-query object that needs to be updated.

/zzzz-patch-named-query
named-query-uuid path string

application/json application/xml

default

Response codes found in response codes.

delete an existing named-query

DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}

Tags: ServiceDesignAndCreation

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

default

Response codes found in response codes.

returns named-query-elements

GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements

Tags: ServiceDesignAndCreation

returns named-query-elements
named-query-uuid path string
named-query-element-uuid

n/a

 query string

application/json application/xml

200 OK

successful operation

/named-query-elements
default

Response codes found in response codes.

returns named-query-element

GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}

Tags: ServiceDesignAndCreation

returns named-query-element
named-query-uuid path string
named-query-element-uuid path string

application/json application/xml

200 OK

successful operation

/named-query-element
default

Response codes found in response codes.

create or update an existing named-query-element

PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}

Tags: ServiceDesignAndCreation

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-element
named-query-uuid path string
named-query-element-uuid path string

application/json application/xml

default

Response codes found in response codes.

update an existing named-query-element

PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}

Tags: ServiceDesignAndCreation

update an existing named-query-element

application/json application/xml

named-query-element object that needs to be updated.

/zzzz-patch-named-query-element
named-query-uuid path string
named-query-element-uuid path string

application/json application/xml

default

Response codes found in response codes.

delete an existing named-query-element

DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}

Tags: ServiceDesignAndCreation

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

default

Response codes found in response codes.

returns property-constraints

GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints

Tags: ServiceDesignAndCreation

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

200 OK

successful operation

/property-constraints
default

Response codes found in response codes.

returns property-constraint

GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}

Tags: ServiceDesignAndCreation

returns property-constraint
named-query-uuid path string
named-query-element-uuid path string
property-constraint-uuid path string

application/json application/xml

200 OK

successful operation

/property-constraint
default

Response codes found in response codes.

create or update an existing property-constraint

PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}

Tags: ServiceDesignAndCreation

create or update an existing property-constraint

application/json application/xml

property-constraint object that needs to be created or updated.

/property-constraint
named-query-uuid path string
named-query-element-uuid path string
property-constraint-uuid path string

application/json application/xml

default

Response codes found in response codes.

update an existing property-constraint

PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}

Tags: ServiceDesignAndCreation

update an existing property-constraint

application/json application/xml

property-constraint object that needs to be updated.

/zzzz-patch-property-constraint
named-query-uuid path string
named-query-element-uuid path string
property-constraint-uuid path string

application/json application/xml

default

Response codes found in response codes.

delete an existing property-constraint

DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}

Tags: ServiceDesignAndCreation

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

default

Response codes found in response codes.

returns related-lookups

GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups

Tags: ServiceDesignAndCreation

returns related-lookups
named-query-uuid path string
named-query-element-uuid path string
related-lookup-uuid

n/a

 query string

application/json application/xml

200 OK

successful operation

/related-lookups
default

Response codes found in response codes.

returns related-lookup

GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}

Tags: ServiceDesignAndCreation

returns related-lookup
named-query-uuid path string
named-query-element-uuid path string
related-lookup-uuid path string

application/json application/xml

200 OK

successful operation

/related-lookup
default

Response codes found in response codes.

create or update an existing related-lookup

PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}

Tags: ServiceDesignAndCreation

create or update an existing related-lookup

application/json application/xml

related-lookup object that needs to be created or updated.

/related-lookup
named-query-uuid path string
named-query-element-uuid path string
related-lookup-uuid path string

application/json application/xml

default

Response codes found in response codes.

update an existing related-lookup

PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}

Tags: ServiceDesignAndCreation

update an existing related-lookup

application/json application/xml

related-lookup object that needs to be updated.

/zzzz-patch-related-lookup
named-query-uuid path string
named-query-element-uuid path string
related-lookup-uuid path string

application/json application/xml

default

Response codes found in response codes.

delete an existing related-lookup

DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}

Tags: ServiceDesignAndCreation

delete an existing related-lookup

application/json application/xml

named-query-uuid path string
named-query-element-uuid path string
related-lookup-uuid path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}/relationship-list/relationship

Tags: ServiceDesignAndCreation

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
named-query-uuid path string
named-query-element-uuid path string
related-lookup-uuid path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}/relationship-list/relationship

Tags: ServiceDesignAndCreation

delete an existing relationship

application/json application/xml

named-query-uuid path string
named-query-element-uuid path string
related-lookup-uuid path string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship

Tags: ServiceDesignAndCreation

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
named-query-uuid path string
named-query-element-uuid path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship

Tags: ServiceDesignAndCreation

delete an existing relationship

application/json application/xml

named-query-uuid path string
named-query-element-uuid path string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship

Tags: ServiceDesignAndCreation

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
named-query-uuid path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship

Tags: ServiceDesignAndCreation

delete an existing relationship

application/json application/xml

named-query-uuid path string

application/json application/xml

default

Response codes found in response codes.

returns service-capabilities

GET /service-design-and-creation/service-capabilities

Tags: ServiceDesignAndCreation

returns service-capabilities
service-type

n/a

 query string
vnf-type

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

200 OK

successful operation

/service-capabilities
default

Response codes found in response codes.

returns service-capability

GET /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

Tags: ServiceDesignAndCreation

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

200 OK

successful operation

/service-capability
default

Response codes found in response codes.

create or update an existing service-capability

PUT /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

Tags: ServiceDesignAndCreation

create or update an existing service-capability

application/json application/xml

service-capability object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing service-capability

PATCH /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

Tags: ServiceDesignAndCreation

update an existing service-capability

application/json application/xml

service-capability object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing service-capability

DELETE /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

Tags: ServiceDesignAndCreation

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship

Tags: ServiceDesignAndCreation

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship

Tags: ServiceDesignAndCreation

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

default

Response codes found in response codes.

returns services

GET /service-design-and-creation/services

Tags: ServiceDesignAndCreation

returns services
service-id

n/a

 query string
service-description

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

200 OK

successful operation

/services
default

Response codes found in response codes.

returns service

GET /service-design-and-creation/services/service/{service-id}

Tags: ServiceDesignAndCreation

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

200 OK

successful operation

/service
default

Response codes found in response codes.

create or update an existing service

PUT /service-design-and-creation/services/service/{service-id}

Tags: ServiceDesignAndCreation

create or update an existing service

application/json application/xml

service object that needs to be created or updated.

/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

default

Response codes found in response codes.

update an existing service

PATCH /service-design-and-creation/services/service/{service-id}

Tags: ServiceDesignAndCreation

update an existing service

application/json application/xml

service object that needs to be updated.

/zzzz-patch-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

default

Response codes found in response codes.

delete an existing service

DELETE /service-design-and-creation/services/service/{service-id}

Tags: ServiceDesignAndCreation

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /service-design-and-creation/services/service/{service-id}/relationship-list/relationship

Tags: ServiceDesignAndCreation

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
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

default

Response codes found in response codes.

delete an existing relationship

DELETE /service-design-and-creation/services/service/{service-id}/relationship-list/relationship

Tags: ServiceDesignAndCreation

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

default

Response codes found in response codes.

returns vnf-images

GET /service-design-and-creation/vnf-images

Tags: ServiceDesignAndCreation

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
data-owner

n/a

 query string
data-source

n/a

 query string
data-source-version

n/a

 query string

application/json application/xml

200 OK

successful operation

/vnf-images
default

Response codes found in response codes.

returns vnf-image

GET /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

Tags: ServiceDesignAndCreation

returns vnf-image
vnf-image-uuid

Unique ID of this asset

 path string

application/json application/xml

200 OK

successful operation

/vnf-image
default

Response codes found in response codes.

create or update an existing vnf-image

PUT /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

Tags: ServiceDesignAndCreation

create or update an existing vnf-image

application/json application/xml

vnf-image object that needs to be created or updated.

/vnf-image
vnf-image-uuid

Unique ID of this asset

 path string

application/json application/xml

default

Response codes found in response codes.

update an existing vnf-image

PATCH /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

Tags: ServiceDesignAndCreation

update an existing vnf-image

application/json application/xml

vnf-image object that needs to be updated.

/zzzz-patch-vnf-image
vnf-image-uuid

Unique ID of this asset

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing vnf-image

DELETE /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

Tags: ServiceDesignAndCreation

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

default

Response codes found in response codes.

see node definition for valid relationships

PUT /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship

Tags: ServiceDesignAndCreation

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

/relationship-dict
vnf-image-uuid

Unique ID of this asset

 path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship

Tags: ServiceDesignAndCreation

delete an existing relationship

application/json application/xml

vnf-image-uuid

Unique ID of this asset

 path string

application/json application/xml

default

Response codes found in response codes.

Schema definitions

action: object

action-type: string
action-data: object[]
action-data

action-data: object

property-name: string
property-value: string

actions: object

APIs that are more action related than REST (e.g., notify, update).

update: object
update
notify: object
notify

activities: object

Collection of activities.

activity: object[]
activity

activity: object

describes an activities

  • TO cloud-region (PARENT of activity, activity AppliesTo cloud-region, MANY2MANY)

    • The activity applies to a cloud-region.(4)

  • TO mapping( activity AppliesTo mapping, MANY2MANY)

    • The reservation information associated with a NAT Pool mapping.

  • TO network-range (PARENT of activity, activity BelongsTo network-range, MANY2ONE)

    • An activity is being performed on a network-range.(4)

  • TO p-interface (PARENT of activity, activity AppliesTo p-interface, MANY2MANY)

    • The activity applies to a p-interface.(4)

  • TO pnf (PARENT of activity, activity AppliesTo pnf, MANY2MANY)

    • The activity applies to a pnf.(4)

  • TO pserver (PARENT of activity, activity AppliesTo pserver, MANY2MANY)

    • The activity applies to a pserver.(4)

  • FROM activity-state (CHILD of activity, activity-state BelongsTo activity, MANY2ONE)

    • An activity-state is tracks the state of an activity.(1)

  • (1) IF this ACTIVITY node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this ACTIVITY is DELETED also
activity-id: string

Unique id for the activity. (UUID)

activity-type: string

Type of activity (ex, provisioning).

activity-name: string

Name of the activity.

activity-creator: string

Application that created the activity.

activity-description: string

Description of activity.

timestamp: string

Date and Time activity is created.

current-state: string

Current state of the activity.

reflected-state: string

State reflected by the database.

activity-role: string

Role

activity-function: string

Function

timestamp-last-updated: string

Date/time last updated

timestamp-expiration: string

Date/time expires

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

activity-states: object[]
activity-state
relationship-list: object
relationship

activity-state: object

describes an activities

  • TO activity (PARENT of activity-state, activity-state BelongsTo activity, MANY2ONE)

    • An activity-state is tracks the state of an activity.(4)

  • (4) IF this TO node is deleted, this ACTIVITY-STATE is DELETED also
state-order: integer

Order for the activity state.

state-name: string

Name of the activity state (ex, NVT-PROV).

state-view: string

View of the activity state.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

activity-states: object

Collection of activity-states

activity-state: object[]
activity-state

address-families: object

address-family: object[]
address-family

address-family: object

Definition of address family

  • TO bgp-group (PARENT of address-family, address-family BelongsTo bgp-group, MANY2ONE)

    • Address Family belongs to a bgp-group(4)

  • TO bgp-neighbor (PARENT of address-family, address-family BelongsTo bgp-neighbor, MANY2ONE)

    • Address Family belongs to a bgp-neighbor(4)

  • FROM policy( policy AppliesTo address-family, MANY2MANY)

    • A policy applies to an address family.

  • (4) IF this TO node is deleted, this ADDRESS-FAMILY is DELETED also
address-family-id: string

address family UUID.

af-type: string

address family type (aka afi)

af-subtype: string

address family subtype (aka safi)

af-role: string

role of address-family

af-function: string

function of address-family

max-prefix-v4: integer

Max prefix for IPv4

max-prefix-v6: integer

Max prefix for IPv6

max-prefix-threshold: integer

Max prefix threshold

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

aggregate-route: object

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.

  • TO l3-network (PARENT of aggregate-route, aggregate-route BelongsTo l3-network, MANY2ONE)(4)
  • TO vrf (PARENT of aggregate-route, aggregate-route BelongsTo vrf, MANY2ONE)

    • An aggregate-route BelongsTo a vrf.(4)

  • FROM vpn-binding( vpn-binding Uses aggregate-route, ONE2MANY)

    • A vpn-binding uses many aggregate routes

  • (4) IF this TO node is deleted, this AGGREGATE-ROUTE is DELETED also
agg-route-id: string

Route UUID.

network-start-address: string

Name of the forwarding-path

cidr-mask: string

CIDR-mask for aggregate route subnet

ip-version: string

Identifies is aggregate route is ipv4 or ipv6

network-address: string

Network Address

next-hop: string

Next Hop

route-path: string

Route Path

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

aggregate-routes: object

Collection of aggregate routes.

aggregate-route: object[]
aggregate-route

aggregated-ether-option: object

Used to specify the aggregated Ethernet properties of a specific aggregated Ethernet interface.

  • TO lag-interface (PARENT of aggregated-ether-option, aggregated-ether-option BindsTo lag-interface, ONE2ONE)

    • used for generic interface parameters(4)

  • FROM lacp (CHILD of aggregated-ether-option, lacp BindsTo aggregated-ether-option, ONE2ONE)

    • used for generic interface parameters(1)

  • (1) IF this AGGREGATED-ETHER-OPTION node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this AGGREGATED-ETHER-OPTION is DELETED also
aggregated-ether-option-id: string

UUID - unique object identifier

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship
lacps: object[]
lacp

aggregated-ether-options: object

Collection of aggregated ether options.

aggregated-ether-option: object[]
aggregated-ether-option

allotted-resource: object

Represents a slice or partial piece of a resource that gets separately allotted

  • TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)

    • AAI-1925

  • TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
  • TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
  • TO l-interface( allotted-resource Uses l-interface, ONE2MANY)
  • TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
  • TO logical-link( allotted-resource ComposedOf logical-link, ONE2MANY)(2)
  • TO network-policy( allotted-resource Uses network-policy, ONE2ONE)
  • TO p-interface( allotted-resource Uses p-interface, ONE2MANY)

    • AAI-1925 For CCVPN Usecase

  • TO service-instance (PARENT of allotted-resource, allotted-resource BelongsTo service-instance, MANY2ONE)(4)
  • TO vlan( allotted-resource PartOf vlan, MANY2MANY)
  • TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY)
  • FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)

    • AAI-1925

  • FROM configuration( configuration Uses allotted-resource, MANY2ONE)
  • FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
  • FROM site-resource( site-resource Uses allotted-resource, MANY2MANY)

    • For CCVPN Usecase

  • FROM tunnel-xconnect (CHILD of allotted-resource, tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)

  • (1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
  • (2) IF this ALLOTTED-RESOURCE node is deleted, this TO node is DELETED also
  • (4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
id: string

Allotted Resource id UUID assigned to this instance.

description: string

The descriptive information assigned to this allotted resource instance

selflink: string

Link back to more information in the controller

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

resource-version: string

Concurrency value

orchestration-status: string

Orchestration status

operational-status: string

Indicator for whether the resource is considered operational

type: string

Generic description of the type of allotted resource.

role: string

role in the network that this resource will be providing.

allotted-resource-name: string

Store the name of this allotted-resource.

access-provider-id: string

Store the id of the access provider of this allotted-resource.

access-client-id: string

Store the id of the access client of this allotted-resource.

access-topology-id: string

Store the id of the access topology of this allotted-resource.

access-node-id: string

Store the id of the access node of this allotted-resource.

access-ltp-id: string

Store the id of the access ltp of this allotted-resource.

cvlan: string

Store the cvlan of this allotted-resource.

vpn-name: string

Store the vpn-name of this allotted-resource.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

tunnel-xconnects: object[]
tunnel-xconnect
relationship-list: object
relationship

allotted-resources: object

This object is used to store slices of services being offered

allotted-resource: object[]
allotted-resource

autonomous-system: object

Description of Autonomous System

  • TO zone( autonomous-system LocatedIn zone, MANY2ONE)

    • A local autonomous-system is located in a zone.(4)

  • FROM bgp-group( bgp-group Destination autonomous-system, MANY2ONE)

    • To node-type is destination of bgp-group.

  • FROM bgp-group( bgp-group Source autonomous-system, MANY2ONE)

    • To node-type is source of bgp-group.

  • FROM bgp-neighbor( bgp-neighbor MemberOf autonomous-system, MANY2ONE)

    • bgp-neighbor is a member of an autonomous-system.

  • FROM pnf( pnf LocatedIn autonomous-system, MANY2ONE)

    • pnf is located in the autonomous-system.

  • (4) IF this TO node is deleted, this AUTONOMOUS-SYSTEM is DELETED also
  • AUTONOMOUS-SYSTEM cannot be deleted if related to BGP-GROUP,BGP-NEIGHBOR,PNF
autonomous-system-id: string

UUID

autonomous-system-number: integer

asn in the range of 0 to 9223372036854775807

autonomous-system-type: string

type (global vs. local).

autonomous-system-region: string

geographic region

autonomous-system-role: string

role of autonomous system

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Concurrency value

relationship-list: object
relationship

autonomous-systems: object

Collection of Autonomous Systems

autonomous-system: object[]
autonomous-system

availability-zone: object

Availability zone, a collection of compute hosts/pservers

  • TO cloud-region (PARENT of availability-zone, availability-zone BelongsTo cloud-region, MANY2ONE)(4)
  • TO complex( availability-zone LocatedIn complex, MANY2ONE)
  • TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
  • FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
  • FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
  • FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
  • FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
  • FROM vce( vce Uses availability-zone, MANY2MANY)

  • (4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
  • AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
availability-zone-name: string

Name of the availability zone. Unique across a cloud region

hypervisor-type: string

Type of hypervisor. Source of truth should define valid values.

operational-status: string

State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

availability-zones: object

Collection of availability zones

availability-zone: object[]
availability-zone

available-bandwidth: object

Instance of an available-bandwidth-map

  • TO bandwidth-attribute (PARENT of available-bandwidth, available-bandwidth BelongsTo bandwidth-attribute, MANY2ONE)

    • For MDONS usecase(4)

  • (4) IF this TO node is deleted, this AVAILABLE-BANDWIDTH is DELETED also
ab-id: string

Id that identifies the attribute

odu-type: string

ODU Type that identifies the ODU Eg. ODU0, ODU1, ODU2, ODU3, ODU4

number: integer

The value of available bandwidth. Applicable only for ENNI.

selflink: string

Store the link to get more information for this object.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

available-bandwidth-map: object

Collection of Available Bandwidth. Added for ENNI in MDONS use case.

available-bandwidth: object[]
available-bandwidth

az-and-dvs-switches: object

dvs-switches: object
dvs-switches
availability-zone: object
availability-zone

bandwidth-attribute: object

Instance of a bandwidth-attribute

  • TO p-interface (PARENT of bandwidth-attribute, bandwidth-attribute BelongsTo p-interface, MANY2ONE)

    • For MDONS usecase(4)

  • FROM available-bandwidth (CHILD of bandwidth-attribute, available-bandwidth BelongsTo bandwidth-attribute, MANY2ONE)

    • For MDONS usecase(1)

  • (1) IF this BANDWIDTH-ATTRIBUTE node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this BANDWIDTH-ATTRIBUTE is DELETED also
bwa-id: string

Id that identifies the bandwidth attribute

selflink: string

Store the link to get more information for this object.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship
available-bandwidth-map: object[]
available-bandwidth

bandwidth-attributes: object

Collection of bandwidth attribute. Added for ENNI in MDONS use case.

bandwidth-attribute: object[]
bandwidth-attribute

bfd: 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.

  • FROM next-hop( next-hop Uses bfd, ONE2ONE)
bfd-id: string

Unique identifier.

bfd-type: string

Used to categorize this object in conjunction with role & function. The most generic category.

bfd-role: string

Used to categorize this object in conjunction with type & function.

bfd-function: string

Used to categorize this object in conjunction with type & role. The most specific category.

bfd-keep-alive: string

bfd keep-alive parameter

bfd-timeout: string

bfd timeout parameter

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

bfd-multihop: string

bfd multihop parameter

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

bfds: object

bfd: object[]
bfd

bgp-group: object

Definition of bgp-group

  • TO autonomous-system( bgp-group Destination autonomous-system, MANY2ONE)

    • To node-type is destination of bgp-group.

  • TO autonomous-system( bgp-group Source autonomous-system, MANY2ONE)

    • To node-type is source of bgp-group.

  • TO l3-interface-ipv4-address-list( bgp-group Destination l3-interface-ipv4-address-list, MANY2ONE)

    • To node-type is destination of bgp-group.

  • TO l3-interface-ipv4-address-list( bgp-group Source l3-interface-ipv4-address-list, MANY2ONE)

    • To node-type is source of bgp-group.

  • TO l3-interface-ipv6-address-list( bgp-group Destination l3-interface-ipv6-address-list, MANY2ONE)

    • To node-type is destination of bgp-group.

  • TO l3-interface-ipv6-address-list( bgp-group Source l3-interface-ipv6-address-list, MANY2ONE)

    • To node-type is source of bgp-group.

  • TO pnf (PARENT of bgp-group, bgp-group BelongsTo pnf, MANY2ONE)

    • A bgp-group belongs to a pnf.(4)

  • TO subnet( bgp-group Destination subnet, MANY2ONE)

    • To node-type is destination of bgp-group.

  • TO subnet( bgp-group Source subnet, MANY2ONE)

    • To node-type is source of bgp-group.

  • TO vip-ipv4-address-list( bgp-group Destination vip-ipv4-address-list, MANY2ONE)

    • To node-type is destination of bgp-group.

  • TO vip-ipv4-address-list( bgp-group Source vip-ipv4-address-list, MANY2ONE)

    • To node-type is source of bgp-group.

  • TO vip-ipv6-address-list( bgp-group Destination vip-ipv6-address-list, MANY2ONE)

    • To node-type is destination of bgp-group.

  • TO vip-ipv6-address-list( bgp-group Source vip-ipv6-address-list, MANY2ONE)

    • To node-type is source of bgp-group.

  • TO vrf (PARENT of bgp-group, bgp-group BelongsTo vrf, MANY2ONE)

    • A bgp-group belongs to a pnf.(4)

  • FROM address-family (CHILD of bgp-group, address-family BelongsTo bgp-group, MANY2ONE)

    • Address Family belongs to a bgp-group(1)

  • FROM bgp-neighbor( bgp-neighbor MemberOf bgp-group, MANY2ONE)

    • bgp-neighbor is a member of an bgp-group.

  • FROM generic-vnf (PARENT of bgp-group, generic-vnf BelongsTo bgp-group, MANY2ONE)

    • The bgp-group associated to a generic-vnf.(3)

  • FROM policy( policy AppliesTo bgp-group, MANY2MANY)

    • A policy applies to a bgp-group.

  • (1) IF this BGP-GROUP node is deleted, this FROM node is DELETED also
  • (3) IF this FROM node is deleted, this BGP-GROUP is DELETED also
  • (4) IF this TO node is deleted, this BGP-GROUP is DELETED also
  • BGP-GROUP cannot be deleted if related to BGP-NEIGHBOR
bgp-group-id: string

UUID.

bgp-group-name: string

name of bgp-group

bgp-group-type: string

type of bgp-group

bgp-group-role: string

role of bgp-group

bgp-group-function: string

function of bgp-group

local-as: integer

local a-s number type of vrf (bridge-domain as an example)

local-address: string

local address

peer-as: integer

peer a-s number

peer-address: string

peer address

description: string

description of bgp-group

ops-note: string

Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

address-families: object[]
address-family
relationship-list: object
relationship

bgp-groups: object

bgp-group: object[]
bgp-group

bgp-neighbor: object

Definition of bgp-neighbor

  • TO autonomous-system( bgp-neighbor MemberOf autonomous-system, MANY2ONE)

    • bgp-neighbor is a member of an autonomous-system.

  • TO bgp-group( bgp-neighbor MemberOf bgp-group, MANY2ONE)

    • bgp-neighbor is a member of an bgp-group.

  • TO l3-interface-ipv4-address-list( bgp-neighbor Uses l3-interface-ipv4-address-list, MANY2ONE)

    • bgp-neighbor uses To node-type.

  • TO l3-interface-ipv6-address-list( bgp-neighbor Uses l3-interface-ipv6-address-list, MANY2ONE)

    • bgp-neighbor uses To node-type.

  • TO logical-link( bgp-neighbor LinksTo logical-link, MANY2ONE)

    • A policy applies to a bgp-neighbor.

  • TO pnf (PARENT of bgp-neighbor, bgp-neighbor BelongsTo pnf, MANY2ONE)

    • A bgp-neighbor belongs to a pnf.(4)

  • TO subnet (PARENT of bgp-neighbor, bgp-neighbor BelongsTo subnet, MANY2ONE)

    • bgp-neighbor belongs To a subnet.(4)

  • TO vip-ipv4-address-list( bgp-neighbor Uses vip-ipv4-address-list, MANY2ONE)

    • bgp-neighbor uses To node-type.

  • TO vip-ipv6-address-list( bgp-neighbor Uses vip-ipv6-address-list, MANY2ONE)

    • bgp-neighbor uses To node-type.

  • TO vrf (PARENT of bgp-neighbor, bgp-neighbor BelongsTo vrf, MANY2ONE)

    • A bgp-neighbor belongs to a vrf.(4)

  • FROM address-family (CHILD of bgp-neighbor, address-family BelongsTo bgp-neighbor, MANY2ONE)

    • Address Family belongs to a bgp-neighbor(1)

  • FROM configuration( configuration Uses bgp-neighbor, MANY2MANY)

    • The configuration Uses bgp-neighbor.

  • FROM generic-vnf (PARENT of bgp-neighbor, generic-vnf BelongsTo bgp-neighbor, MANY2ONE)

    • The bgp-neighbor associated to a generic-vnf.(3)

  • FROM policy( policy AppliesTo bgp-neighbor, MANY2MANY)

    • A policy applies to a bgp-neighbor.

  • (1) IF this BGP-NEIGHBOR node is deleted, this FROM node is DELETED also
  • (3) IF this FROM node is deleted, this BGP-NEIGHBOR is DELETED also
  • (4) IF this TO node is deleted, this BGP-NEIGHBOR is DELETED also
bgp-neighbor-id: string

UUID.

bgp-neighbor-type: string

name of bgp-group

bgp-neighbor-role: string

type of bgp-group

bgp-neighbor-function: string

role of bgp-group

local-as: integer

local a-s number type of vrf (bridge-domain as an example)

local-address: string

local address

peer-as: integer

peer a-s number

peer-address: string

peer address

description: string

description of bgp-group

ops-note: string

Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.

prov-status: string

provisioning status. Valid values [PREPROV/NVTPROV/PROV].

peer-hostname: string

hostname of the peer

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship
address-families: object[]
address-family

bgp-neighbors: object

bgp-neighbor: object[]
bgp-neighbor

business: object

Namespace for business related constructs

connectors: object[]
connector
customers: object[]
customer
lines-of-business: object[]
line-of-business
owning-entities: object[]
owning-entity
platforms: object[]
platform
projects: object[]
project
sp-partners: object[]
sp-partner

cable: object

Definition of cable

  • TO complex (PARENT of cable, cable LocatedIn complex, MANY2ONE)

    • A cable is located in a complex.(4)

  • TO hardware-catalog-item( cable IsA hardware-catalog-item, MANY2ONE)

    • The cable is this item from the hardware-catalog.

  • TO physical-link( cable ComposedOf physical-link, ONE2MANY)

    • A cable is composed of one or more physical-links.

  • FROM pluggable( pluggable PartOf cable, MANY2ONE)

    • A pluggable that is intergrated with a cable.(1)

  • FROM port( port LinksTo cable, MANY2ONE)

    • A channel-interface terminates a channel-link.

  • (1) IF this CABLE node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this CABLE is DELETED also
cable-name: string

A unique name for the channel-link relative to the physical-link.

cable-type: string

The type of cable.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

cables: object

cable: object[]
cable

card: object

Definition of card

  • TO card-slot (PARENT of card, card LocatedIn card-slot, ONE2ONE)

    • A card is located in a card-slot.(4)

  • TO hardware-catalog-item( card IsA hardware-catalog-item, MANY2ONE)

    • The card is described by the hardware-catalog-item.

  • FROM pluggable-slot (CHILD of card, pluggable-slot LocatedIn card, MANY2ONE)

    • A pluggable slot is located in a card.(1)

  • FROM port (CHILD of card, port LocatedIn card, MANY2ONE)

    • A port is located in a card.(1)

  • FROM profile( profile AppliesTo card, MANY2MANY)

    • The profile (set of characteristics) applies to the card.

  • (1) IF this CARD node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this CARD is DELETED also
card-type: string

The type of card.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship
ports: object[]
port
pluggable-slots: object[]
pluggable-slot

card-slot: object

Definition of card-slot

  • TO chassis (PARENT of card-slot, card-slot LocatedIn chassis, MANY2ONE)

    • A card-slot is located in a chassis.(4)

  • FROM card (CHILD of card-slot, card LocatedIn card-slot, ONE2ONE)

    • A card is located in a card-slot.(1)

  • (1) IF this CARD-SLOT node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this CARD-SLOT is DELETED also
slot-name: string

The name of the card-slot (unique relative to the chassis).

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

cards: object[]
card
relationship-list: object
relationship

card-slots: object

card-slot: object[]
card-slot

cards: object

card: object[]
card

chassies: object

chassis: object[]
chassis

chassis: object

Definition of chassis

  • TO complex( chassis LocatedIn complex, MANY2ONE)

    • A chassis LinksTo a complex.

  • TO hardware-catalog-item( chassis IsA hardware-catalog-item, MANY2ONE)

    • The chassis is described by the hardware-catalog-item.

  • TO pnf( chassis PartOf pnf, MANY2ONE)

    • A chassis is part of a pnf.

  • TO pserver( chassis PartOf pserver, MANY2MANY)

    • A chassis is part of a pserver.

  • TO rack( chassis LocatedIn rack, MANY2ONE)

    • A chassis is LocatedIn a rack.

  • TO rack-unit( chassis Uses rack-unit, ONE2MANY)

    • A chassis uses space in a rack (aka one or more rack-units).

  • FROM card-slot (CHILD of chassis, card-slot LocatedIn chassis, MANY2ONE)

    • A card-slot is located in a chassis.(1)

  • FROM license (CHILD of chassis, license BelongsTo chassis, MANY2ONE)

    • A license belongs to a chassis.(1)

  • FROM pluggable-slot (CHILD of chassis, pluggable-slot LocatedIn chassis, MANY2ONE)

    • A pluggable-slot is located in a chassis.(1)

  • FROM port (CHILD of chassis, port LocatedIn chassis, MANY2ONE)

    • A port is LocatedIn a chassis.(1)

  • FROM profile( profile AppliesTo chassis, MANY2MANY)

    • The profile (set of characteristics) applies to the chassis.

  • (1) IF this CHASSIS node is deleted, this FROM node is DELETED also
chassis-name: string

A globally unique name for the chassis.

chassis-type: string

The type of chassis..

chassis-role: string

The role of the chassis relative to the pnf/pserver..

operating-system: string

Operating system of the hardware.

serial-number: string

The serial number of the chassis..

asset-tag: string

The asset tag of the chassis.

chassis-description: string

Description of the chassis.

part-number: string

Part number for this chassis.

orchestration-status: string

Orchestration status of this chassis.

equip-model: string

Equipment model.

equip-vendor: string

Equipment vendor. Source of truth should define valid values.

equip-identifier: string

CLEI or other specification for chassis hardware.

slot-number: integer

Slot number associated with this chassis.

admin-state: string

Reflects the admin-state of the device.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

ports: object[]
port
card-slots: object[]
card-slot
pluggable-slots: object[]
pluggable-slot
licenses: object[]
license
relationship-list: object
relationship

class-map: object

Class map related to a policy map member used for QOS

  • FROM class-map-member( class-map-member MemberOf class-map, MANY2ONE)

    • Member of class map

  • FROM policy-map-member( policy-map-member Uses class-map, MANY2MANY)

    • Class-map related to policy-map-member

  • CLASS-MAP cannot be deleted if related to CLASS-MAP-MEMBER
class-map-id: string

unique ID

class-map-name: string

name of class-map

class-map-type: string

valid values are TRAFFIC or default

class-map-role: string

valid values are MATCH-ALL or MATCH-ANY

class-map-function: string

function of class-map

direction: string

direction set as ingress or egress

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

class-map-member: object

Member of a class map

  • TO parameter-list( class-map-member Uses parameter-list, MANY2MANY)

    • class-map-member to parameter-list

  • TO class-map( class-map-member MemberOf class-map, MANY2ONE)

    • Member of class map

  • CLASS-MAP-MEMBER cannot be deleted if related to PARAMETER-LIST
class-map-member-id: string

unique ID

sequence-number: string

numeric indicating the sequence of the member

member-type: string

valid values are action or end-class-map

action: string

valid value is match

action-type: string

describes the action-type

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

class-map-members: object

Collection of class map members.

class-map-member: object[]
class-map-member

class-maps: object

Collection of class maps.

class-map: object[]
class-map

class-of-service: object

Captures data and voice protocols to differentiate the types of payloads contained in the packet being transmitted.

  • TO site-pair (PARENT of class-of-service, class-of-service BelongsTo site-pair, MANY2ONE)(4)

  • (4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
cos: string

unique identifier of probe

probe-id: string

identifier of probe

probe-type: string

type of probe

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

classes-of-service: object

class-of-service of probe

class-of-service: object[]
class-of-service

cloud-infrastructure: object

Namespace for cloud infrastructure.

complexes: object[]
complex
cloud-regions: object[]
cloud-region
network-profiles: object[]
network-profile
pservers: object[]
pserver
endpoints: object[]
endpoint
virtual-data-centers: object[]
virtual-data-center
operational-environments: object[]
operational-environment
geo-regions: object[]
geo-region
network-technologies: object[]
network-technology

cloud-region: object

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.

  • TO complex( cloud-region LocatedIn complex, MANY2ONE)
  • TO endpoint( cloud-region Uses endpoint, MANY2MANY)
  • TO geo-region( cloud-region MemberOf geo-region, MANY2MANY)

    • The cloud-region associated to a geo-region

  • TO instance-group( cloud-region Uses instance-group, ONE2MANY)
  • TO l3-network( cloud-region Uses l3-network, MANY2MANY)
  • TO network-technology( cloud-region Uses network-technology, MANY2MANY)
  • TO policy( cloud-region Implements policy, MANY2MANY)

    • a cloud-region implements policies

  • TO project( cloud-region PartOf project, MANY2ONE)

    • The cloud-region is part of a project (ex, project that built out the cloud region).

  • TO service-instance( cloud-region Uses service-instance, MANY2MANY)
  • TO zone( cloud-region LocatedIn zone, MANY2ONE)
  • FROM activity (CHILD of cloud-region, activity AppliesTo cloud-region, MANY2MANY)

    • The activity applies to a cloud-region.(1)

  • FROM availability-zone (CHILD of cloud-region, availability-zone BelongsTo cloud-region, MANY2ONE)(1)
  • FROM contact( contact Supports cloud-region, ONE2MANY)

    • The contact supports a cloud-region.

  • FROM dvs-switch (CHILD of cloud-region, dvs-switch BelongsTo cloud-region, MANY2ONE)
  • FROM esr-system-info (CHILD of cloud-region, esr-system-info BelongsTo cloud-region, MANY2ONE)(1)
  • FROM flavor (CHILD of cloud-region, flavor BelongsTo cloud-region, MANY2ONE)
  • FROM generic-vnf( generic-vnf LocatedIn cloud-region, MANY2ONE)
  • FROM group-assignment (CHILD of cloud-region, group-assignment BelongsTo cloud-region, MANY2ONE)
  • FROM host-aggregate (CHILD of cloud-region, host-aggregate BelongsTo cloud-region, MANY2ONE)(1)
  • FROM hpa-capability (CHILD of cloud-region, hpa-capability BelongsTo cloud-region, MANY2ONE)
  • FROM image (CHILD of cloud-region, image BelongsTo cloud-region, MANY2ONE)
  • FROM line-of-business( line-of-business Uses cloud-region, MANY2MANY)
  • FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
  • FROM mapping( mapping LocatedIn cloud-region, MANY2MANY)

    • The mapping associated to a cloud-region

  • FROM network-range( network-range LocatedIn cloud-region, MANY2MANY)

    • The network-range is located in a cloud-region

  • FROM oam-network (CHILD of cloud-region, oam-network BelongsTo cloud-region, MANY2ONE)
  • FROM object-group( object-group LocatedIn cloud-region, MANY2MANY)

    • The object-group is located in a cloud-region

  • FROM pnf( pnf LocatedIn cloud-region, MANY2ONE)

    • A pnf is located in (aka supports) a cloud-region.

  • FROM pnf( pnf Uses cloud-region, MANY2MANY)

    • used for CSP pnf to cloud-region.

  • FROM profile( profile AppliesTo cloud-region, MANY2MANY)
  • FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
  • FROM snapshot (CHILD of cloud-region, snapshot BelongsTo cloud-region, MANY2ONE)
  • FROM tenant (CHILD of cloud-region, tenant BelongsTo cloud-region, MANY2ONE)
  • FROM validation-audit (CHILD of cloud-region, validation-audit BelongsTo cloud-region, ONE2ONE)

    • The validation-audit associated to a cloud-region(1)

  • FROM vip-ipv4-address-list (CHILD of cloud-region, vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
  • FROM vip-ipv6-address-list (CHILD of cloud-region, vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
  • FROM vlan-range (CHILD of cloud-region, vlan-range BelongsTo cloud-region, MANY2ONE)

    • A vlan range belongs to a cloud-region.(1)

  • FROM vlan-tag( vlan-tag BelongsTo cloud-region, MANY2ONE)
  • FROM volume-group (CHILD of cloud-region, volume-group BelongsTo cloud-region, MANY2ONE)

  • (1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
  • CLOUD-REGION cannot be deleted if related to ENDPOINT,DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,HPA-CAPABILITY,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
cloud-owner: string

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

cloud-region-id: string

Identifier used by the vendor for the region. Second part of composite key

cloud-type: string

Type of the cloud (e.g., openstack)

owner-defined-type: string

Cloud-owner defined type indicator (e.g., dcp, lcp)

cloud-region-version: string

Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.

identity-url: string

URL of the keystone identity service

cloud-zone: string

Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.

complex-name: string

complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.

sriov-automation: string

Whether the cloud region supports (true) or does not support (false) SR-IOV automation.

cloud-extra-info: string

ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.

cloud-region-number: integer

Number that maps to the letter at the end of the cloud-region-id.

cloud-function: string

Function of cloud-region.

cloud-role: string

Role of cloud-region.

ops-note: string

Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.

cloud-region-number-definition: string

The alias used for this cloud.

status: string

Status of cloud-region.

upgrade-cycle: string

Upgrade cycle for the cloud region. For AIC regions upgrade cycle is designated by A,B,C etc.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

orchestration-disabled: boolean

Used to indicate whether orchestration is enabled for this cloud-region.

in-maint: boolean

Used to indicate whether or not cloud-region object is in maintenance mode.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

volume-groups: object[]
volume-group
tenants: object[]
tenant
flavors: object[]
flavor
group-assignments: object[]
group-assignment
snapshots: object[]
snapshot
images: object[]
image
dvs-switches: object[]
dvs-switch
oam-networks: object[]
oam-network
availability-zones: object[]
availability-zone
relationship-list: object
relationship
vip-ipv4-address-list: object[]
vip-ipv4-address-list
vip-ipv6-address-list: object[]
vip-ipv6-address-list
vlan-ranges: object[]
vlan-range
host-aggregates: object[]
host-aggregate
activities: object[]
activity
validation-audits: object[]
validation-audit
hpa-capabilities: object[]
hpa-capability
esr-system-info-list: object[]
esr-system-info

cloud-regions: object

cloud-region: object[]
cloud-region

collection: object

represents the collection resource in the TOSCA model

  • FROM instance-group( instance-group BelongsTo collection, ONE2ONE)
  • FROM service-instance( service-instance ComposedOf collection, ONE2ONE)
collection-id: string

Collection Object UUID

model-invariant-id: string

ASDC model id for this resource or service model

model-version-id: string

Model Version

collection-name: string

collection name

collection-type: string

Collection type

collection-role: string

Collection Role

collection-function: string

Collection function

orchestration-status: string

orchestration status

collection-customization-id: string

Captures the id of all the configuration used to customize the resource for the service

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

collections: object

collection: object[]
collection

common: object

Namespace for common inventory resources.

hardware-catalog-items: object[]
hardware-catalog-item
contacts: object[]
contact
profiles: object[]
profile
object-groups: object[]
object-group
policies: object[]
policy
vlan-characteristics: object[]
vlan-characteristic
relationship-rules: object[]
relationship-rule
parameter-lists: object[]
parameter-list
class-map-members: object[]
class-map-member
class-maps: object[]
class-map
policy-key-terms: object[]
policy-key-term
policy-map-members: object[]
policy-map-member

communication-service-profile: object

Requirement of comunication service.

  • TO service-instance (PARENT of communication-service-profile, communication-service-profile BelongsTo service-instance, ONE2ONE)
profile-id: string

ID of the profile.

max-number-of-UEs: integer

The maximum number of UEs may simultaneously access the communication service

coverage-area-list: string

A list of TrackingAreas where the NSI can be selected.

latency: integer

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.

exp-data-rate-UL: integer

User experience data rate of upload.

exp-data-rate-DL: integer

User experience data rate of download.

ue-mobility-level: string

User mobility level, value can be stationary, nomadic, restricted mobility, fully mobility.

resource-sharing-level: string

Whether the resources to be allocated to the network slice instance may be shared with another network slice instance(s).

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

communication-service-profiles: object

Collection of communication service profile.

communication-service-profile: object[]
communication-service-profile

community-list: object

Community List

  • TO object-group (PARENT of community-list, community-list BelongsTo object-group, MANY2ONE)(4)

  • (4) IF this TO node is deleted, this COMMUNITY-LIST is DELETED also
community-value: string

String value

type: string

String type

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

complex: object

Collection of physical locations that can house cloud-regions.

  • TO endpoint( complex Uses endpoint, MANY2MANY)
  • TO geo-region( complex MemberOf geo-region, MANY2MANY)

    • The complex associated to a geo-region

  • TO l3-network( complex Uses l3-network, MANY2MANY)
  • FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
  • FROM cable (CHILD of complex, cable LocatedIn complex, MANY2ONE)

    • A cable is located in a complex.(1)

  • FROM chassis( chassis LocatedIn complex, MANY2ONE)

    • A chassis LinksTo a complex.

  • FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
  • FROM contact( contact Supports complex, ONE2MANY)

    • The contact supports a complex.

  • FROM ctag-pool (CHILD of complex, ctag-pool BelongsTo complex, MANY2ONE)(1)
  • FROM generic-vnf( generic-vnf LocatedIn complex, MANY2MANY)
  • FROM network-range( network-range LocatedIn complex, MANY2MANY)

    • The network-range is located in a complex

  • FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
  • FROM object-group( object-group LocatedIn complex, MANY2MANY)

    • The object-group is located in a complex

  • FROM pnf( pnf LocatedIn complex, MANY2ONE)
  • FROM pserver( pserver LocatedIn complex, MANY2ONE)
  • FROM rack (CHILD of complex, rack LocatedIn complex, MANY2ONE)

    • A rack is located in a complex (aka building).(1)

  • FROM site-resource( site-resource Uses complex, MANY2MANY)

    • For CCVPN Usecase

  • FROM vce( vce LocatedIn complex, MANY2MANY)
  • FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
  • FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
  • FROM zone( zone LocatedIn complex, MANY2ONE)

  • (1) IF this COMPLEX node is deleted, this FROM node is DELETED also
  • COMPLEX cannot be deleted if related to ENDPOINT,AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
physical-location-id: string

Unique identifier for physical location, e.g., CLLI

data-center-code: string

Data center code which can be an alternate way to identify a complex

complex-name: string

Gamma complex name for LCP instance.

identity-url: string

URL of the keystone identity service

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

physical-location-type: string

Type, e.g., central office, data center.

time-zone: string

The time zone where the complex is located.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

street1: string
street2: string
city: string
state: string
postal-code: string
country: string
region: string
latitude: string
longitude: string
elevation: string
lata: string
racks: object[]
rack
cables: object[]
cable
ctag-pools: object[]
ctag-pool
relationship-list: object
relationship

complexes: object

Collection of physical locations that can house cloud-regions.

complex: object[]
complex

composed-resource: object

Represents a resource that acts as a bridge between service-instance to define parent-child relationship

  • TO service-instance (PARENT of composed-resource, composed-resource ComposedOf service-instance, MANY2ONE)(4)
  • FROM service-instance( service-instance BelongsTo composed-resource, ONE2ONE)

  • (4) IF this TO node is deleted, this COMPOSED-RESOURCE is DELETED also
id: string

Composed Resource id UUID assigned to this instance.

description: string

The descriptive information assigned to this composed resource instance

selflink: string

Link back to more information in the controller

resource-version: string

Concurrency value

orchestration-status: string

Orchestration status

operational-status: string

Indicator for whether the resource is considered operational

type: string

Generic description of the type of composed resource.

role: string

role in the network that this resource will be providing.

composed-resource-name: string

Store the name of this composed-resource.

access-provider-id: string

Store the id of the access provider of this composed-resource.

access-client-id: string

Store the id of the access client of this composed-resource.

access-topology-id: string

Store the id of the access topology of this composed-resource.

access-node-id: string

Store the id of the access node of this composed-resource.

access-ltp-id: string

Store the id of the access ltp of this composed-resource.

cvlan: string

Store the cvlan of this composed-resource.

vpn-name: string

Store the vpn-name of this composed-resource.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

composed-resources: object

This object is used to store slices of services being offered

composed-resource: object[]
composed-resource

configuration: object

Generic configuration object.

  • TO allotted-resource( configuration Uses allotted-resource, MANY2ONE)
  • TO bgp-neighbor( configuration Uses bgp-neighbor, MANY2MANY)

    • The configuration Uses bgp-neighbor.

  • TO configuration( configuration BindsTo configuration, ONE2ONE)
  • TO instance-group( configuration PartOf instance-group, MANY2ONE)
  • TO l-interface( configuration AppliesTo l-interface, MANY2MANY)
  • TO l3-network( configuration PartOf l3-network, MANY2MANY)
  • TO lag-interface( configuration AppliesTo lag-interface, MANY2ONE)
  • TO logical-link( configuration Uses logical-link, ONE2MANY)
  • TO network-route( configuration Uses network-route, MANY2MANY)

    • Relates configuration to network-route for static routes.

  • TO pnf( configuration AppliesTo pnf, MANY2MANY)
  • TO policy( configuration Uses policy, MANY2MANY)

    • A configuration uses a policy

  • TO subnet( configuration Uses subnet, ONE2MANY)

    • A configuration uses a subnet

  • TO vnfc( configuration Uses vnfc, ONE2ONE)(4)
  • TO vpn-binding( configuration Uses vpn-binding, MANY2ONE)
  • TO vrf( configuration Uses vrf, MANY2MANY)

    • A Configuration uses VRFs

  • FROM configuration( configuration BindsTo configuration, ONE2ONE)
  • FROM evc (CHILD of configuration, evc BelongsTo configuration, ONE2ONE)(1)
  • FROM forwarder( forwarder Uses configuration, ONE2ONE)(3)
  • FROM forwarder-evc (CHILD of configuration, forwarder-evc BelongsTo configuration, ONE2ONE)(1)
  • FROM forwarding-path( forwarding-path Uses configuration, ONE2ONE)(3)
  • FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
  • FROM metadatum (CHILD of configuration, metadatum BelongsTo configuration, MANY2ONE)(1)
  • FROM service-instance( service-instance Uses configuration, ONE2MANY)
  • FROM service-instance( service-instance ComposedOf configuration, MANY2MANY)

  • (1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
  • (3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
  • (4) IF this TO node is deleted, this CONFIGURATION is DELETED also
  • CONFIGURATION cannot be deleted if related to NETWORK-ROUTE
configuration-id: string

UUID assigned to configuration.

management-option: string

Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.

configuration-name: string

Name of the configuration.

configuration-type: string

port-mirroring-configuration.

configuration-sub-type: string

vprobe, pprobe.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

orchestration-status: string

Orchestration status of the configuration.

operational-status: string

Indicator for whether the resource is considered operational.

configuration-selflink: string

URL to endpoint where AAI can get more details from SDN-GC.

model-customization-id: string

id of the configuration used to customize the resource

tunnel-bandwidth: string

DHV Site Effective Bandwidth

vendor-allowed-max-bandwidth: string

Velocloud Nominal Throughput - VNT

config-policy-name: string

Used to capture the name of the fabric configuration policy that was used to generate the payload sent to PINC for fabric configuration.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

configuration-role: string

Used to categorize the configuration.

configuration-function: string

Used to categorize the configuration.

primary-role: boolean

Used by some configurations to identify if it's filling a primary role.

orchestration-version: string

Used to categorize the configuration.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship
metadata: object[]
metadatum
forwarder-evcs: object[]
forwarder-evc
evcs: object[]
evc

configurations: object

Collection of configurations

configuration: object[]
configuration

connectivities: object

Collection of connectivities

connectivity: object[]
connectivity

connectivity: object

Instance of a connectivity

  • TO connectivity( connectivity LinksTo connectivity, MANY2MANY)

    • For CCVPN Usecase -- ETree super and slave connectivity

  • TO ext-aai-network( connectivity BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • TO generic-vnf( connectivity PartOf generic-vnf, MANY2MANY)

    • For CCVPN Usecase

  • TO service-instance( connectivity PartOf service-instance, MANY2MANY)

    • For CCVPN Usecase

  • TO uni( connectivity PartOf uni, MANY2MANY)

    • For CCVPN Usecase -- ETree

  • TO vpn-binding( connectivity BindsTo vpn-binding, MANY2MANY)

    • For CCVPN Usecase

  • FROM connectivity( connectivity LinksTo connectivity, MANY2MANY)

    • For CCVPN Usecase -- ETree super and slave connectivity

connectivity-id: string

Uniquely identifies this connectivity by id

bandwidth-profile-name: string

Store the name of a bandwidth profile.

vpn-type: string

Store the type of a bandwidth profile.

cir: string

Store the CIR of this connectivity.

eir: string

Store the EIR of this connectivity.

cbs: string

Store the CBS of this connectivity.

ebs: string

Store the EBS of this connectivity.

color-aware: string

Store the color-awareness of this connectivity.

coupling-flag: string

Store the coupling flag of this connectivity.

etht-svc-name: string

The ethernet service name for this connectivity.

access-provider-id: string

Store the id of the access provider of this connectivity.

access-client-id: string

Store the id of the access client of this connectivity.

access-topology-id: string

Store the id of the access topology of this connectivity.

access-node-id: string

Store the id of the access node of this connectivity.

access-ltp-id: string

Store the id of the access ltp of this connectivity.

connectivity-selflink: string

Store the link to get more information for this connectivity.

cvlan: string

Store the cvlan for this connectivity.

operational-status: string

Store the operational-status of this connectivity.

admin-status: string

Store the admin-status of this connectivity.

protection-type: string

Store the protection-type of this connectivity.

slice-id: string

Store the ID of the transport slice to which this connectivity may belong.

model-customization-id: string

Store the model-customization-id for this object.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

connector: object

Collection of resource instances used to connect a variety of disparate inventory widgets

  • TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
  • FROM metadatum (CHILD of connector, metadatum BelongsTo connector, MANY2ONE)(1)
  • FROM service-instance( service-instance Uses connector, MANY2MANY)

  • (1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
resource-instance-id: string

Unique id of resource instance.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

widget-model-id: string

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

widget-model-version: string

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship
metadata: object[]
metadatum

connectors: object

Collection of resource instances used to connect a variety of disparate inventory widgets

connector: object[]
connector

constrained-element-set: object

This is how we would capture constraints defining allowed sets of elements.

  • TO model-constraint (PARENT of constrained-element-set, constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
  • TO model-element (PARENT of constrained-element-set, constrained-element-set BelongsTo model-element, MANY2ONE)(4)
  • FROM element-choice-set (CHILD of constrained-element-set, element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)

  • (1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
constrained-element-set-uuid: string
data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

constraint-type: string
check-type: string
resource-version: string
element-choice-sets: object[]
element-choice-set
relationship-list: object
relationship

constrained-element-sets: object

constrained-element-set: object[]
constrained-element-set

contact: object

Contacts store the vendor information and have a relationship to the generic-vnf. In 1902, this will be populated by SDN-GC

  • TO cloud-region( contact Supports cloud-region, ONE2MANY)

    • The contact supports a cloud-region.

  • TO complex( contact Supports complex, ONE2MANY)

    • The contact supports a complex.

  • TO generic-vnf( contact supports generic-vnf, MANY2MANY)
  • TO pnf( contact Supports pnf, ONE2MANY)

    • The contact supports a pnf.

  • TO pserver( contact Supports pserver, ONE2MANY)

    • The contact supports a pserver.

  • TO zone( contact Supports zone, ONE2MANY)

    • The contact supports a zone.

  • CONTACT cannot be deleted if related to CLOUD-REGION,COMPLEX,PNF,PSERVER,ZONE
contact-name: string

Name of the contact

contact-telephone: string

Tel no. of contact

contact-email: string

e-mail of contact

vendor-type: string

NI (Network Integrator)SI (System Integrator) 3rd Party LCM

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

contacts: object

Collection of contacts

contact: object[]
contact

cp: object

Captures the point of attachment from services or resources to a virtual link or network.

  • FROM l-interface( l-interface LinksTo cp, ONE2ONE)
  • FROM l3-interface-ipv4-address-list (CHILD of cp, l3-interface-ipv4-address-list BelongsTo cp, MANY2ONE)(1)
  • FROM l3-interface-ipv6-address-list (CHILD of cp, l3-interface-ipv6-address-list BelongsTo cp, MANY2ONE)(1)
  • FROM l3-network( l3-network LinksTo cp, MANY2MANY)
  • FROM metadatum( metadatum AppliesTo cp, MANY2MANY)

    • AAI-2154 For BBS Usecase

  • FROM vip-ipv4-address-list( vip-ipv4-address-list Uses cp, MANY2MANY)
  • FROM vip-ipv6-address-list( vip-ipv6-address-list Uses cp, MANY2MANY)
  • FROM vlan-tag( vlan-tag Uses cp, MANY2MANY)
  • FROM vnfc (PARENT of cp, vnfc BelongsTo cp, ONE2MANY)

    • cp is child of vnfc(3)

  • (1) IF this CP node is deleted, this FROM node is DELETED also
  • (3) IF this FROM node is deleted, this CP is DELETED also
cp-instance-id: string

Unique ID of the connection point.

port-id: integer

port index to represent multiple CPs on VNFC connected to same network.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship
l3-interface-ipv4-address-list: object[]
l3-interface-ipv4-address-list
l3-interface-ipv6-address-list: object[]
l3-interface-ipv6-address-list

cps: object

Collection of connection points.

cp: object[]
cp

ctag-assignment: object

  • TO l3-network (PARENT of ctag-assignment, ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
  • FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)

  • (4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
vlan-id-inner: integer

id.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

ctag-assignments: object

ctag-assignment: object[]
ctag-assignment

ctag-pool: object

A collection of C tags (vlan tags) grouped for a specific purpose.

  • TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
  • TO complex (PARENT of ctag-pool, ctag-pool BelongsTo complex, MANY2ONE)(4)
  • FROM generic-vnf( generic-vnf Uses ctag-pool, MANY2MANY)
  • FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)

  • (4) IF this TO node is deleted, this CTAG-POOL is DELETED also
target-pe: string

The Target provider edge router

availability-zone-name: string

Name of the availability zone

ctag-pool-purpose: string

Describes what the intended purpose of this pool is.

ctag-values: string

Comma separated list of ctags

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

ctag-pools: object

ctag-pool: object[]
ctag-pool

customer: object

customer identifiers to provide linkage back to BSS information.

  • FROM service-subscription (CHILD of customer, service-subscription BelongsTo customer, MANY2ONE)

    • service-subscription BelongsTo customer(1)

  • FROM vpn-binding( vpn-binding Uses customer, MANY2MANY)

  • (1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
global-customer-id: string

Global customer id used across ONAP to uniquely identify customer.

subscriber-name: string

Subscriber name, an alternate way to retrieve a customer.

subscriber-type: string

Subscriber type, a way to provide VID with only the INFRA customers.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

service-subscriptions: object[]
service-subscription
relationship-list: object
relationship

customers: object

Collection of customer identifiers to provide linkage back to BSS information.

customer: object[]
customer

cvlan-tag-entry: object

cvlan-tag: integer

See mis-na-virtualization-platform.yang

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

cvlan-tags: object

cvlan-tag-entry: object[]
cvlan-tag-entry

device: object

Instance of a device

  • TO ext-aai-network( device BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • TO generic-vnf( device Uses generic-vnf, ONE2MANY)

    • For CCVPN Usecase

  • TO service-instance( device PartOf service-instance, ONE2MANY)

    • For CCVPN Usecase

device-id: string

Uniquely identifies this device by id

esn: string

Store the esn of this device.

device-name: string

Store the name of this device.

description: string

Store the description of this device.

vendor: string

Store the vendor of this device.

class: string

Store the class of this device.

type: string

Store the type of this device.

version: string

Store the version of this device.

system-ip: string

Store the system-ip of this device.

system-ipv4: string

Store the system-ipv4 of this device.

system-ipv6: string

Store the system-ipv6 of this device.

selflink: string

Store the link to get more information for this object.

operational-status: string

Store the operational-status for this object.

model-customization-id: string

Store the model-customization-id for this object.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

devices: object

Collection of devices

device: object[]
device

dhcp-service: object

Instance of a dhcp-service

  • FROM lan-port-config (PARENT of dhcp-service, lan-port-config Uses dhcp-service, ONE2MANY)

    • For CCVPN Usecase(3)

  • (3) IF this FROM node is deleted, this DHCP-SERVICE is DELETED also
dhcp-service-id: string

Uniquely identifies this dhcp-service by id

server-ipv4-address: string

Store the server-ip4-address of this dhcp-service.

server-ipv6-address: string

Store the server-ipv6-address of this dhcp-service.

service-enable: string

Store the service-enable of this dhcp-service.

dhcp-service-type: string

Store the dhcp-service-type of this dhcp-service.

lease-time: string

Store the lease-time of this dhcp-service.

domain-name: string

Store the domain-name of this dhcp-service.

dns: string

Store the dns of this dhcp-service.

ntp-primary: string

Store the ntp-primary of this dhcp-service.

ntp-secondary: string

Store the ntp-secondary of this dhcp-service.

nbns: string

Store the nbns of this dhcp-service.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

dhcp-services: object

Collection of dhcp-services

dhcp-service: object[]
dhcp-service

dvs-switch: object

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.

  • TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
  • TO cloud-region (PARENT of dvs-switch, dvs-switch BelongsTo cloud-region, MANY2ONE)
switch-name: string

DVS switch name

vcenter-url: string

URL used to reach the vcenter

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

dvs-switches: object

Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.

dvs-switch: object[]
dvs-switch

edge-prop-names: object

Internal map to define the properties of an edge and interpret the map EdgeRules

edgeLabel: string
direction: string
multiplicityRule: string
contains-other-v: string
delete-other-v: string
SVC-INFRA: string
prevent-delete: string
aai-uuid: string

edge-tag-query-request: object

edge-tag: string
result-detail: string
start-node-type: string
start-node-filter: object[]
start-node-filter
include-node-filter: object[]
include-node-filter
secondary-filter: object[]
secondary-filter

edge-tag-query-result: object

tagged-inventory-item-list: object[]
tagged-inventory-item-list

element-choice-set: object

This is how we would capture constraints defining allowed sets of elements.

  • TO constrained-element-set (PARENT of element-choice-set, element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
  • FROM model-element (CHILD of element-choice-set, model-element BelongsTo element-choice-set, MANY2ONE)(1)

  • (1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
element-choice-set-uuid: string
data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

element-choice-set-name: string
cardinality: string
resource-version: string
model-elements: object[]
model-element
relationship-list: object
relationship

element-choice-sets: object

element-choice-set: object[]
element-choice-set

endpoint: object

describes an endpoints

  • FROM cloud-region( cloud-region Uses endpoint, MANY2MANY)
  • FROM complex( complex Uses endpoint, MANY2MANY)
  • FROM ip-address-list (CHILD of endpoint, ip-address-list BelongsTo endpoint, MANY2ONE)(1)
  • FROM platform( platform Uses endpoint, ONE2MANY)

    • Used by Auditing applications to identify appropriate audit models based on the platform associated with the given object

  • FROM pnf( pnf Uses endpoint, MANY2MANY)
  • FROM port-list (CHILD of endpoint, port-list BelongsTo endpoint, MANY2ONE)(1)
  • FROM profile( profile AppliesTo endpoint, MANY2MANY)

    • A profile (set of characteristics) applies to the endpoint.

  • FROM pserver( pserver Uses endpoint, MANY2MANY)
  • FROM relationship-rule( relationship-rule AppliesTo endpoint, MANY2MANY)

    • Details relationships endpoint requires

  • FROM selector-list (CHILD of endpoint, selector-list BelongsTo endpoint, MANY2ONE)(1)
  • FROM zone( zone Uses endpoint, MANY2MANY)

  • (1) IF this ENDPOINT node is deleted, this FROM node is DELETED also
endpoint-id: string

Unique identifier for the endpoint.

endpoint-name: string

Name of the endpoint.

endpoint-type: string

Type of the endpoint. Expected values are DNS, ETCD, Kubernetes, etc.

endpoint-name2: string

Alternate name of the endpoint

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship
ip-address-list: object[]
ip-address-list
port-list: object[]
port-list
selector-list: object[]
selector-list

endpoints: object

Collection of endpoints.

endpoint: object[]
endpoint

entitlement: object

Metadata for entitlement group.

  • TO generic-vnf (PARENT of entitlement, entitlement BelongsTo generic-vnf, MANY2ONE)(4)
  • TO vce (PARENT of entitlement, entitlement BelongsTo vce, MANY2ONE)(4)

  • (4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
group-uuid: string

Unique ID for the entitlement group the resource comes from, should be uuid.

resource-uuid: string

Unique ID of an entitlement resource.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Concurrency value

relationship-list: object
relationship

entitlements: object

Entitlements, keyed by group-uuid and resource-uuid, related to license management

entitlement: object[]
entitlement

esi: object

specifies Ethernet Segment Identifier associated with a lag-interface.

  • TO lag-interface (PARENT of esi, esi BindsTo lag-interface, ONE2ONE)

    • used for generic interface parameters(4)

  • (4) IF this TO node is deleted, this ESI is DELETED also
esi-id: string

object identifier

active-option: string

Values, null, all-active, single-active

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

esis: object

Collection of esis.

esi: object[]
esi

esr-ems: object

Persist EMS address information used by EMS driver.

  • FROM esr-system-info (CHILD of esr-ems, esr-system-info BelongsTo esr-ems, MANY2ONE)(1)

  • (1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
ems-id: string

Unique ID of EMS.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

esr-system-info-list: object[]
esr-system-info
relationship-list: object
relationship

esr-ems-list: object

esr-ems: object[]
esr-ems

esr-nfvo: object

Persist NFVO address information used by VF-C.

  • FROM esr-system-info (CHILD of esr-nfvo, esr-system-info BelongsTo esr-nfvo, ONE2ONE)(1)

  • (1) IF this ESR-NFVO node is deleted, this FROM node is DELETED also
nfvo-id: string

Unique ID of nfvo.

api-root: string

indecate the api-root.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

esr-system-info-list: object[]
esr-system-info
relationship-list: object
relationship

esr-nfvo-list: object

esr-nfvo: object[]
esr-nfvo

esr-system-info: object

Persist common address information of external systems.

  • TO cloud-region (PARENT of esr-system-info, esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
  • TO esr-ems (PARENT of esr-system-info, esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
  • TO esr-nfvo (PARENT of esr-system-info, esr-system-info BelongsTo esr-nfvo, ONE2ONE)(4)
  • TO esr-thirdparty-sdnc (PARENT of esr-system-info, esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
  • TO esr-vnfm (PARENT of esr-system-info, esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
  • FROM ext-aai-network (PARENT of esr-system-info, ext-aai-network Uses esr-system-info, ONE2MANY)

    • For CCVPN Usecase(3)

  • (3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also
  • (4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
esr-system-info-id: string

Unique ID of esr system info.

system-name: string

name of external system.

type: string

type of external systems.

vendor: string

vendor of external systems.

version: string

version of external systems.

service-url: string

url used to access external systems.

user-name: string

username used to access external systems.

password: string

password used to access external systems.

system-type: string

it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.

protocol: string

protocol of third party SDNC, for example netconf/snmp.

ssl-cacert: string

ca file content if enabled ssl on auth-url.

ssl-insecure: boolean

Whether to verify VIM's certificate.

ip-address: string

service IP of ftp server.

port: string

service port of ftp server.

cloud-domain: string

domain info for authentication.

default-tenant: string

default tenant of VIM.

passive: boolean

ftp passive mode or not.

remote-path: string

resource or performance data file path.

system-status: string

the status of external system.

openstack-region-id: string

OpenStack region ID used by MultiCloud plugin to interact with an OpenStack instance.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

esr-system-info-list: object

Collection of persistent block-level external system auth info.

esr-system-info: object[]
esr-system-info

esr-thirdparty-sdnc: object

Persist SDNC address information used by ONAP SDNC.

  • TO network-resource( esr-thirdparty-sdnc BelongsTo network-resource, ONE2MANY)

    • For MDONS Usecase(2)

  • TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
  • FROM esr-system-info (CHILD of esr-thirdparty-sdnc, esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)

  • (1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
  • (2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also
thirdparty-sdnc-id: string

Unique ID of SDNC.

location: string

used for DC type to indicate the location of SDNC, such as Core or Edge.

product-name: string

password used to access SDNC server.

domain-type: string

Domain type of the SDNC controllerr.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

esr-system-info-list: object[]
esr-system-info
relationship-list: object
relationship

esr-thirdparty-sdnc-list: object

esr-thirdparty-sdnc: object[]
esr-thirdparty-sdnc

esr-vnfm: object

Persist VNFM address information used by VF-C.

  • FROM esr-system-info (CHILD of esr-vnfm, esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
  • FROM generic-vnf( generic-vnf DependsOn esr-vnfm, MANY2ONE)

  • (1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
vnfm-id: string

Unique ID of VNFM.

vim-id: string

indecate the VIM to deploy VNF.

certificate-url: string

certificate url of VNFM.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

esr-system-info-list: object[]
esr-system-info
relationship-list: object
relationship

esr-vnfm-list: object

esr-vnfm: object[]
esr-vnfm

evc: object

evc object is an optional child object of the Configuration object.

  • TO configuration (PARENT of evc, evc BelongsTo configuration, ONE2ONE)(4)

  • (4) IF this TO node is deleted, this EVC is DELETED also
evc-id: string

Unique/key field for the evc object

forwarding-path-topology: string

Point-to-Point, Multi-Point

cir-value: string

Commited Information Rate

cir-units: string

CIR units

cmtu: integer

Size of the Customer Requested MTU (Maximum Transmission Unit).

connection-diversity-group-id: string

Diversity Group ID

service-hours: string

formerly Performance Group

enhanced-multicast: string

String value indicating whether the EVC uses enhanced multicast. Possible Values:yes/no/[empty string]

esp-evc-circuit-id: string

EVC Circuit ID of ESP EVC

esp-evc-cir-value: string

Committed Information Rate (For ESP)

esp-evc-cir-units: string

CIR units (For ESP)

esp-itu-code: string

Identifies ESP

collector-pop-clli: string

Collector POP CLLI (from the hostname of the access pnf)

inter-connect-type-ingress: string

Interconnect type on ingress side of EVC.

tagmode-access-ingress: string

tagode for collector side of EVC

tagmode-access-egress: string

tagMode for network side of EVC

product-entry-id: string

Product ID

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

evcs: object

evc: object[]
evc

ext-aai-network: object

Refer to an external AAI in another ONAP.

  • TO esr-system-info (PARENT of ext-aai-network, ext-aai-network Uses esr-system-info, ONE2MANY)

    • For CCVPN Usecase(2)

  • FROM connectivity( connectivity BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • FROM device( device BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • FROM lan-port-config( lan-port-config BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • FROM logical-link( logical-link BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • FROM network-resource( network-resource BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • FROM pnf( pnf BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • FROM sdwan-vpn( sdwan-vpn BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • FROM site-resource( site-resource BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • FROM vpn-binding( vpn-binding BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • FROM wan-port-config( wan-port-config BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • (2) IF this EXT-AAI-NETWORK node is deleted, this TO node is DELETED also
  • EXT-AAI-NETWORK cannot be deleted if related to CONNECTIVITY,DEVICE,LAN-PORT-CONFIG,LOGICAL-LINK,NETWORK-RESOURCE,PNF,SDWAN-VPN,SITE-RESOURCE,VPN-BINDING,WAN-PORT-CONFIG
aai-id: string

Unique ID of the referenced AAI.

schema-version: string

Schema version of the referenced AAI.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

esr-system-info: object
esr-system-info
relationship-list: object
relationship

ext-aai-networks: object

ext-aai-network: object[]
ext-aai-network

external-system: object

Namespace for external system.

esr-ems-list: object[]
esr-ems
esr-vnfm-list: object[]
esr-vnfm
esr-nfvo-list: object[]
esr-nfvo
esr-thirdparty-sdnc-list: object[]
esr-thirdparty-sdnc

extra-properties: object

Extra properties for inventory item for response list

extra-property: object[]
extra-property

extra-property: object

property-name: string
property-value: string

flavor: object

Openstack flavor.

  • TO cloud-region (PARENT of flavor, flavor BelongsTo cloud-region, MANY2ONE)
  • TO pserver( flavor CanBeInstantiatedIn pserver, MANY2MANY)

    • HPA Capacity getting the compute nodes from given flavor

  • FROM hpa-capability (CHILD of flavor, hpa-capability BelongsTo flavor, MANY2ONE)
  • FROM vserver( vserver Uses flavor, MANY2ONE)

  • FLAVOR cannot be deleted if related to HPA-CAPABILITY,VSERVER
flavor-id: string

Flavor id, expected to be unique across cloud-region.

flavor-name: string

Flavor name

flavor-vcpus: integer

Number of CPUs

flavor-ram: integer

Amount of memory

flavor-disk: integer

Disk space

flavor-ephemeral: integer

Amount of ephemeral disk space

flavor-swap: string

amount of swap space allocation

flavor-is-public: boolean

whether flavor is available to all users or private to the tenant it was created in.

flavor-selflink: string

URL to endpoint where AAI can get more details

flavor-disabled: boolean

Boolean as to whether this flavor is no longer enabled

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

hpa-capabilities: object[]
hpa-capability
relationship-list: object
relationship

flavors: object

Collection of openstack flavors.

flavor: object[]
flavor

forwarder: object

Entity describing a sequenced segment of forwarding path

  • TO configuration( forwarder Uses configuration, ONE2ONE)(2)
  • TO forwarding-path (PARENT of forwarder, forwarder BelongsTo forwarding-path, MANY2ONE)(4)
  • TO generic-vnf( forwarder AppliesTo generic-vnf, MANY2MANY)

    • Points to the generic-vnf(s) involved in this forwarding step.

  • TO l-interface( forwarder ForwardsTo l-interface, MANY2MANY)
  • TO lag-interface( forwarder ForwardsTo lag-interface, MANY2MANY)
  • TO p-interface( forwarder ForwardsTo p-interface, MANY2MANY)

  • (2) IF this FORWARDER node is deleted, this TO node is DELETED also
  • (4) IF this TO node is deleted, this FORWARDER is DELETED also
sequence: integer

Unique ID of this segmentation

forwarder-role: string

ingress, intermediate, egress

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

forwarder-evc: object

forwarder object is an optional child object of the Configuration object.

  • TO configuration (PARENT of forwarder-evc, forwarder-evc BelongsTo configuration, ONE2ONE)(4)
  • FROM vlan-mapping (CHILD of forwarder-evc, vlan-mapping BelongsTo forwarder-evc, MANY2ONE)(1)

  • (1) IF this FORWARDER-EVC node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
forwarder-evc-id: string

Key for forwarder-evc object

circuit-id: string

Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC

ivlan: string

Internal VLAN.

svlan: string

SVLAN value for ingress of egress forwarder.

cvlan: string

CVLAN value for ingress of egress forwarder.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

vlan-mappings: object[]
vlan-mapping
relationship-list: object
relationship

forwarder-evcs: object

forwarder-evc: object[]
forwarder-evc

forwarders: object

forwarder: object[]
forwarder

forwarding-path: object

Entity that describes the sequenced forwarding path between interfaces of services or resources

  • TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
  • TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
  • FROM forwarder (CHILD of forwarding-path, forwarder BelongsTo forwarding-path, MANY2ONE)(1)

  • (1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
  • (2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
  • (4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
forwarding-path-id: string

Unique ID of this FP

forwarding-path-name: string

Name of the FP

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

selflink: string

the self link for this FP

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship
forwarders: object[]
forwarder

forwarding-paths: object

forwarding-path: object[]
forwarding-path

fqdn: object

A fully qualified domain name (FQDN) is the complete domain name for a specific computer, or host, on the internet.

  • TO fqdn( fqdn AppliesTo fqdn, MANY2MANY)

    • The dns cname record that applies to an A-record (ipv4) and/or quad-A-record (ipv6).

  • TO generic-vnf( fqdn AppliesTo generic-vnf, MANY2ONE)

    • The fqdn that applies to a generic-vnf.

  • TO l3-interface-ipv4-address-list( fqdn AppliesTo l3-interface-ipv4-address-list, ONE2ONE)

    • The fqdn that applies to a l3-interface-ipv4-address-list.

  • TO l3-interface-ipv6-address-list( fqdn AppliesTo l3-interface-ipv6-address-list, ONE2ONE)

    • The fqdn that applies to a l3-interface-ipv6-address-list.

  • TO vip-ipv4-address-list( fqdn AppliesTo vip-ipv4-address-list, ONE2ONE)

    • The fqdn that applies to a vip-ipv4-address-list.

  • TO vip-ipv6-address-list( fqdn AppliesTo vip-ipv6-address-list, ONE2ONE)

    • The fqdn that applies to a vip-ipv6-address-list.

  • FROM fqdn( fqdn AppliesTo fqdn, MANY2MANY)

    • The dns cname record that applies to an A-record (ipv4) and/or quad-A-record (ipv6).

fqdn: string

Fully qualified domain name.

fqdn-type: string

Used to categorize this object in conjunction with role & function. The most generic category.

fqdn-role: string

Used to categorize this object in conjunction with type & function.

fqdn-function: string

Used to categorize this object in conjunction with type & role. The most specific category.

dns-domain: string

Domain name.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

fqdns: object

fqdn: object[]
fqdn

generic-vnf: object

General purpose VNF

  • TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
  • TO bgp-group (PARENT of generic-vnf, generic-vnf BelongsTo bgp-group, MANY2ONE)

    • The bgp-group associated to a generic-vnf.(2)

  • TO bgp-neighbor (PARENT of generic-vnf, generic-vnf BelongsTo bgp-neighbor, MANY2ONE)

    • The bgp-neighbor associated to a generic-vnf.(2)

  • TO cloud-region( generic-vnf LocatedIn cloud-region, MANY2ONE)
  • TO complex( generic-vnf LocatedIn complex, MANY2MANY)
  • TO configuration( generic-vnf Uses configuration, ONE2MANY)(2)
  • TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY)
  • TO esr-vnfm( generic-vnf DependsOn esr-vnfm, MANY2ONE)
  • TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
  • TO instance-group( generic-vnf Uses instance-group, ONE2MANY)
  • TO instance-group( generic-vnf Primary instance-group, ONE2MANY)
  • TO instance-group( generic-vnf Secondary instance-group, ONE2MANY)
  • TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
  • TO k8s-resource( generic-vnf HostedOn k8s-resource, ONE2MANY)
  • TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
  • TO nos-server( generic-vnf HostedOn nos-server, MANY2ONE)
  • TO object-group( generic-vnf AppliesTo object-group, MANY2MANY)

    • A relationship that ties the device to the prefix-list/community-list.

  • TO pnf( generic-vnf HostedOn pnf, MANY2MANY)
  • TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
  • TO tenant( generic-vnf BelongsTo tenant, MANY2ONE)
  • TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
  • TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
  • TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
  • TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
  • FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
  • FROM connectivity( connectivity PartOf generic-vnf, MANY2MANY)

    • For CCVPN Usecase

  • FROM contact( contact supports generic-vnf, MANY2MANY)
  • FROM device( device Uses generic-vnf, ONE2MANY)

    • For CCVPN Usecase

  • FROM entitlement (CHILD of generic-vnf, entitlement BelongsTo generic-vnf, MANY2ONE)(1)
  • FROM forwarder( forwarder AppliesTo generic-vnf, MANY2MANY)

    • Points to the generic-vnf(s) involved in this forwarding step.

  • FROM fqdn( fqdn AppliesTo generic-vnf, MANY2ONE)

    • The fqdn that applies to a generic-vnf.

  • FROM instance-group( instance-group BelongsTo generic-vnf, MANY2ONE)(1)
  • FROM l-interface (CHILD of generic-vnf, l-interface BelongsTo generic-vnf, MANY2ONE)(1)
  • FROM lag-interface (CHILD of generic-vnf, lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
  • FROM lan-port-config( lan-port-config PartOf generic-vnf, MANY2MANY)

    • For CCVPN Usecase

  • FROM license (CHILD of generic-vnf, license BelongsTo generic-vnf, MANY2ONE)(1)
  • FROM line-of-business( line-of-business Uses generic-vnf, MANY2MANY)
  • FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
  • FROM metadatum( metadatum AppliesTo generic-vnf, MANY2MANY)

    • AAI-2154 For BBS Usecase

  • FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
  • FROM platform( platform Uses generic-vnf, MANY2MANY)
  • FROM sdwan-vpn( sdwan-vpn PartOf generic-vnf, MANY2MANY)

    • For CCVPN Usecase

  • FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
  • FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
  • FROM site-resource( site-resource PartOf generic-vnf, MANY2MANY)

    • For CCVPN Usecase

  • FROM uni( uni PartOf generic-vnf, MANY2MANY)

    • For CCVPN Usecase

  • FROM vf-module (CHILD of generic-vnf, vf-module BelongsTo generic-vnf, MANY2ONE)(1)
  • FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
  • FROM wan-port-config( wan-port-config PartOf generic-vnf, MANY2MANY)

    • For CCVPN Usecase

  • (1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
  • (2) IF this GENERIC-VNF node is deleted, this TO node is DELETED also
vnf-id: string

Unique id of VNF. This is unique across the graph.

vnf-instance-id: string

vnf instance id.

vnf-name: string

Name of VNF.

vnf-name2: string

Alternate name of VNF.

vnf-type: string

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

service-id: string

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

regional-resource-zone: string

Regional way of organizing pservers, source of truth should define values

prov-status: string

Trigger for operational monitoring of this resource by Service Assurance systems.

operational-status: string

Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.

license-key: string

OBSOLETE - do not use

equipment-role: string

Client should send valid enumerated value

orchestration-status: string

Orchestration status of this VNF, used by MSO.

vnf-package-name: string
vnf-discriptor-name: string

vnf discriptor name

job-id: string

job id corresponding to vnf

heat-stack-id: string

Heat stack id corresponding to this instance, managed by MSO

mso-catalog-key: string

Corresponds to the SDN-C catalog id used to configure this VCE

management-option: string

identifier of managed customer

ipv4-oam-address: string

Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.

ipv4-loopback0-address: string

v4 Loopback0 address

nm-lan-v6-address: string

v6 Loopback address

management-v6-address: string

v6 management address

vcpu: integer

number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE

vcpu-units: string

units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE

vmemory: integer

number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE

vmemory-units: string

units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE

vdisk: integer

number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE

vdisk-units: string

units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE

nshd: integer

number of associated SHD in vnf.

nvm: integer

number of vms in vnf.

nnet: integer

number of network in vnf.

in-maint: boolean

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.

is-closed-loop-disabled: boolean

used to indicate whether closed loop function is enabled on this node

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

summary-status: string

details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.

encrypted-access-flag: boolean

indicates whether generic-vnf access uses SSH

entitlement-assignment-group-uuid: string

UUID of the Entitlement group used for licensing VNFs, OBSOLETE - See child relationships.

entitlement-resource-uuid: string

UUID of the specific entitlement resource. OBSOLETE - See child relationships.

license-assignment-group-uuid: string

UUID of the license assignment group. OBSOLETE - See child relationships.

license-key-uuid: string

UUID of the actual license resource. OBSOLETE - See child relationships.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

persona-model-version: string

the ASDC model version for this resource or service model.

model-customization-id: string

captures the id of all the configuration used to customize the resource for the service.

widget-model-id: string

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

widget-model-version: string

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

as-number: string

as-number of the VNF

regional-resource-subzone: string

represents sub zone of the rr plane

nf-type: string

Generic description of the type of NF

nf-function: string

English description of Network function that the specific VNF deployment is providing

nf-role: string

role in the network that this model will be providing

nf-naming-code: string

string assigned to this model used for naming purposes

selflink: string

Path to the controller object.

ipv4-oam-gateway-address: string

Gateway address

ipv4-oam-gateway-address-prefix-length: integer

Prefix length for oam-address

vlan-id-outer: integer

Temporary location for S-TAG to get to VCE

nm-profile-name: string

Network Management profile of this VNF

software-version: string

VNF instance specific software version

application-id: string

vnf application-id

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship
l-interfaces: object[]
l-interface
lag-interfaces: object[]
lag-interface
vf-modules: object[]
vf-module
licenses: object[]
license
bgp-groups: object[]
bgp-group
bgp-neighbors: object[]
bgp-neighbor
entitlements: object[]
entitlement

generic-vnfs: object

Collection of VNFs

generic-vnf: object[]
generic-vnf

geo-region: object

Top level node for a cg-nat geographical region.

  • FROM cloud-region( cloud-region MemberOf geo-region, MANY2MANY)

    • The cloud-region associated to a geo-region

  • FROM complex( complex MemberOf geo-region, MANY2MANY)

    • The complex associated to a geo-region

  • FROM lag-interface( lag-interface MemberOf geo-region, MANY2MANY)

    • The lag-interface associated to a geo-region

geo-region-id: string

UUID, key for geo-region object.

geo-region-name: string

Name of geo-region

geo-region-type: string

Type of geo-region

geo-region-role: string

Role of geo-region

geo-region-function: string

Function of geo-region

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string
relationship-list: object
relationship

geo-regions: object

Collection of geo-regions

geo-region: object[]
geo-region

gig-ether-option: object

specifies any gigabit ethernet options associated with a p-interface.

  • TO p-interface (PARENT of gig-ether-option, gig-ether-option BindsTo p-interface, ONE2ONE)

    • used for generic interface parameters(4)

  • (4) IF this TO node is deleted, this GIG-ETHER-OPTION is DELETED also
gig-ether-option-id: string

UUID - unique object identifier

fec: string

Forward Error Correction Values, null, FEC91, and other future values

lacp-on-bundle-id: string

link aggregation control protocol on bundle id

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

gig-ether-options: object

Collection of gig ether options.

gig-ether-option: object[]
gig-ether-option

group-assignment: object

Openstack group-assignment used to store exclusivity groups (EG).

  • TO cloud-region (PARENT of group-assignment, group-assignment BelongsTo cloud-region, MANY2ONE)
  • FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
  • FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
group-id: string

Group id, expected to be unique across cloud-region.

group-type: string

Group type - the type of group this instance refers to

group-name: string

Group name - name assigned to the group

group-description: string

Group description - description of the group

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

group-assignments: object

Collection of openstack group assignments

group-assignment: object[]
group-assignment

hardware-catalog-item: object

describes an hardware-catalog-items

  • FROM cable( cable IsA hardware-catalog-item, MANY2ONE)

    • The cable is this item from the hardware-catalog.

  • FROM card( card IsA hardware-catalog-item, MANY2ONE)

    • The card is described by the hardware-catalog-item.

  • FROM chassis( chassis IsA hardware-catalog-item, MANY2ONE)

    • The chassis is described by the hardware-catalog-item.

  • FROM pdu( pdu IsA hardware-catalog-item, MANY2ONE)

    • The pdu is described by the hardware-catalog-item.

  • FROM pluggable( pluggable IsA hardware-catalog-item, MANY2ONE)

    • The pluggable is described by the hardware-catalog-item.

  • FROM profile( profile AppliesTo hardware-catalog-item, MANY2MANY)

    • A set of characteristics of the hardware-catalog-item.

  • FROM rack( rack IsA hardware-catalog-item, MANY2ONE)

    • The rack is this item from the hardware-catalog.

  • HARDWARE-CATALOG-ITEM cannot be deleted if related to CABLE,CARD,CHASSIS,PDU,PLUGGABLE,RACK
item-name: string

Unique name for the hardware-catalog-item

system-type: string

Type of system defined by ATT

manufacturer: string

Manufacturer of the hardware-catalog-item (ex,Cisco)

model: string

Model of the hardware-catalog-item (ex,5501 NCS)

part-number: string

Part number assigned by the manufacturer

description: string

Description of the hardware-catalog-item

sku: string

Stock-keeping-unit (ATT specific identifier for the hardware-catalog-item)

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

hardware-catalog-items: object

Collection of hardware-catalog-items

hardware-catalog-item: object[]
hardware-catalog-item

hold-timer: object

The hold timer enables interface damping by not advertising interface transitions until the hold timer duration has passed.

  • TO p-interface (PARENT of hold-timer, hold-timer BindsTo p-interface, ONE2ONE)

    • used for generic interface parameters(4)

  • (4) IF this TO node is deleted, this HOLD-TIMER is DELETED also
hold-timer-id: string

UUID - unique object identifier

up: string

hold timer value for interface transition from down to up

down: string

hold timer value for interface transition from up to down

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

hold-timers: object

Collection of hold timers.

hold-timer: object[]
hold-timer

host-aggregate: object

describes an hostAggregates

  • TO cloud-region (PARENT of host-aggregate, host-aggregate BelongsTo cloud-region, MANY2ONE)(4)
  • TO pserver( host-aggregate BelongsTo pserver, MANY2ONE)

  • (4) IF this TO node is deleted, this HOST-AGGREGATE is DELETED also
host-aggregate-id: string

Unique identifier for the host-aggregate.

host-aggregate-name: string

Name of the host-aggregate.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

host-aggregates: object

Collection of HostAggregates.

host-aggregate: object[]
host-aggregate

host-route: object

Route packets to a specific host. Host routes are automatically added to the routing table for all IPv4 and IPv6 addresses that are configured on the router. The purpose of a host route is to create a corresponding CEF entry as a receive entry so that the packets destined to this IP address can be processed by the router itself.

  • TO subnet (PARENT of host-route, host-route BelongsTo subnet, MANY2ONE)(4)

  • (4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
host-route-id: string

host-route id

route-prefix: string

subnet prefix

next-hop: string

Could be ip-address, hostname, or service-instance

next-hop-type: string

Should be ip-address, hostname, or service-instance to match next-hop

metric: integer

Value that is assigned to an IP route for a particular network interface that identifies the cost that is associated with using that route.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

host-routes: object

host-route: object[]
host-route

hpa-capabilities: object

Collection of HPA Capabilities

hpa-capability: object[]
hpa-capability

hpa-capability: object

Represents a HPA capability

  • TO cloud-region (PARENT of hpa-capability, hpa-capability BelongsTo cloud-region, MANY2ONE)
  • TO flavor (PARENT of hpa-capability, hpa-capability BelongsTo flavor, MANY2ONE)
  • FROM hpa-feature-attributes (CHILD of hpa-capability, hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)

  • (1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
hpa-capability-id: string

UUID to uniquely identify a HPA capability

hpa-feature: string

Name of the HPACapability

hpa-version: string

HPA schema version

architecture: string

Hardware architecture

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship
hpa-feature-attributes: object[]
hpa-feature-attributes

hpa-capacity: object

HPA Capacity information for compute node

  • TO pserver (PARENT of hpa-capacity, hpa-capacity BelongsTo pserver, MANY2ONE)

    • HPA Capacity KV for given compute node(4)

  • (4) IF this TO node is deleted, this HPA-CAPACITY is DELETED also
hpa-capacity-key: string

Composite key formed with hpaFeature and append list of hpaFeatureAttributes needed for capacity check

hpa-capacity-value: string

JSON string specifying the capacity (total,free), unit and metadata of the specific HPA attribute

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

hpa-feature-attributes: object

HPA Capability Feature attributes

  • TO hpa-capability (PARENT of hpa-feature-attributes, hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)

  • (4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
hpa-attribute-key: string

name of the specific HPA attribute

hpa-attribute-value: string

JSON string specifying the value, unit and type of the specific HPA attribute

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

hw-component: object

create/update/delete the hw-component node

  • TO profile( hw-component AppliesTo profile, MANY2MANY)

    • The profile associated to a hw-component

  • FROM pnf( pnf MemberOf hw-component, MANY2ONE)

    • The hw-component associated to a pnf

  • FROM pserver( pserver MemberOf hw-component, MANY2ONE)

    • The hw-component associated to a pserver

hw-component-id: string

UUID

hw-component-name: string

Name of hardware component

hw-component-type: string

Type of hardware component

hw-component-role: string

Role of hardware component

hw-component-function: string

Function of hardware component

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

hw-components: object

hw-component: object[]
hw-component

image: object

Openstack image.

  • TO cloud-region (PARENT of image, image BelongsTo cloud-region, MANY2ONE)
  • FROM metadatum (CHILD of image, metadatum BelongsTo image, MANY2ONE)(1)
  • FROM vserver( vserver Uses image, MANY2ONE)

  • (1) IF this IMAGE node is deleted, this FROM node is DELETED also
  • IMAGE cannot be deleted if related to VSERVER
image-id: string

Image id, expected to be unique across cloud region

image-name: string

Image name

image-architecture: string

Operating system architecture.

image-os-distro: string

The common name of the operating system distribution in lowercase

image-os-version: string

The operating system version as specified by the distributor.

application: string

The application that the image instantiates.

application-vendor: string

The vendor of the application.

application-version: string

The version of the application.

image-selflink: string

URL to endpoint where AAI can get more details

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship
metadata: object[]
metadatum

images: object

Collectio of Openstack images.

image: object[]
image

include-node-filter: object

include-node-type: string

instance-filter: object

InstanceFilter for performing a named-query or model query

instance-filters: object

InstanceFilters for performing a named-query or model query

instance-filter: object[]
instance-filter

instance-group: object

General mechanism for grouping instances

  • TO collection( instance-group BelongsTo collection, ONE2ONE)
  • TO generic-vnf( instance-group BelongsTo generic-vnf, MANY2ONE)(4)
  • TO instance-group( instance-group AppliesTo instance-group, MANY2MANY)

    • The instance-group associated to an instance-group

  • TO model( instance-group Targets model, MANY2MANY)
  • FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
  • FROM cloud-region( cloud-region Uses instance-group, ONE2MANY)
  • FROM configuration( configuration PartOf instance-group, MANY2ONE)
  • FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
  • FROM generic-vnf( generic-vnf Uses instance-group, ONE2MANY)
  • FROM generic-vnf( generic-vnf Primary instance-group, ONE2MANY)
  • FROM generic-vnf( generic-vnf Secondary instance-group, ONE2MANY)
  • FROM instance-group( instance-group AppliesTo instance-group, MANY2MANY)

    • The instance-group associated to an instance-group

  • FROM l-interface( l-interface MemberOf instance-group, MANY2MANY)
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
  • FROM l3-network( l3-network MemberOf instance-group, MANY2MANY)
  • FROM mapping( mapping Current instance-group, MANY2MANY)
  • FROM mapping( mapping MemberOf instance-group, MANY2MANY)

    • The mapping associated to an instance-group

  • FROM mapping( mapping Target instance-group, MANY2MANY)
  • FROM pnf( pnf MemberOf instance-group, MANY2MANY)
  • FROM pnf( pnf Primary instance-group, MANY2MANY)
  • FROM pnf( pnf Secondary instance-group, MANY2MANY)
  • FROM policy( policy AppliesTo instance-group, MANY2ONE)

    • The policy associated to an instance-group

  • FROM profile( profile AppliesTo instance-group, MANY2MANY)

    • A profile (set of characteristics) applies to the instance-group (as a vrrp group).

  • FROM rack( rack MemberOf instance-group, MANY2ONE)

    • The rack is a member of the instance-group (rack-group or pod).

  • FROM service-instance( service-instance Uses instance-group, ONE2MANY)

    • MSO creates this edge on VNF Group Service creation

  • FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
  • FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
  • FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
  • FROM vnfc( vnfc MemberOf instance-group, MANY2MANY)
  • FROM vrf( vrf Primary instance-group, MANY2MANY)

    • used for vrf fallback

  • FROM vrf( vrf Secondary instance-group, MANY2MANY)

    • used for vrf fallback

  • FROM vserver( vserver MemberOf instance-group, MANY2MANY)

  • (4) IF this TO node is deleted, this INSTANCE-GROUP is DELETED also
  • INSTANCE-GROUP cannot be deleted if related to RACK
id: string

Instance Group ID, UUID assigned to this instance.

instance-group-role: string

role of the instance group.

model-invariant-id: string

ASDC model id for this resource or service model.

model-version-id: string

ASDC model version uid for this resource model.

description: string

Descriptive text to help identify the usage of this instance-group

instance-group-type: string

Only valid value today is lower case ha for high availability

resource-version: string

Concurrency value

instance-group-name: string

Instance-Group Name.

instance-group-function: string

Instance-Group Function

instance-group-number: integer

Number used to identify an instance-group

priority-number: string

Used to identify the primary and secondary priority

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

instance-groups: object

Collection of openstack route table references

instance-group: object[]
instance-group

interlayer-attachment: object

Instance of an inter layer topology attachment

  • FROM p-interface( p-interface LinksTo interlayer-attachment, MANY2MANY)

    • For CCVPN Usecase(1)

  • FROM tunnel-termination-point( tunnel-termination-point LinksTo interlayer-attachment, MANY2MANY)

    • For CCVPN Usecase(1)

  • (1) IF this INTERLAYER-ATTACHMENT node is deleted, this FROM node is DELETED also
id: string

Id that identifies the interlayer topology attachment

inter-layer-lockId: integer

Inter layer lock id

selflink: string

Store the link to get more information for this object.

model-customization-id: string

Store the model-customization-id for this object.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

interlayer-attachments: object

Collection of interlayer topology connectivities.

interlayer-attachment: object[]
interlayer-attachment

inventory: object

cloud-infrastructure: object
cloud-infrastructure
external-system: object
external-system
business: object
business
service-design-and-creation: object
service-design-and-creation
network: object
network
common: object
common

inventory-item: object

inventory-item-type: string
inventory-item-link: string
inventory-item-data: object[]
inventory-item-data
tagged-inventory-item-list: object[]
tagged-inventory-item-list

inventory-item-data: object

property-name: string
property-value: string

inventory-response-item: object

Inventory item for response list

model-name: string
extra-properties: object
extra-properties
inventory-response-items: object
inventory-response-items

inventory-response-items: object

Container for inventory items in response list

inventory-response-item: object[]
inventory-response-item

ip-address-list: object

IP Address Range

  • TO endpoint (PARENT of ip-address-list, ip-address-list BelongsTo endpoint, MANY2ONE)(4)
  • TO l3-interface-ipv4-address-list( ip-address-list Uses l3-interface-ipv4-address-list, ONE2ONE)

    • 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

  • TO l3-interface-ipv6-address-list( ip-address-list Uses l3-interface-ipv6-address-list, ONE2ONE)

    • 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

  • TO object-group (PARENT of ip-address-list, ip-address-list BelongsTo object-group, MANY2ONE)(4)
  • TO policy (PARENT of ip-address-list, ip-address-list BelongsTo policy, MANY2ONE)

    • An ip-address-list BelongsTo a policy.(4)

  • TO port-list( ip-address-list BelongsTo port-list, MANY2MANY)
  • TO rule (PARENT of ip-address-list, ip-address-list BelongsTo rule, MANY2ONE)(4)
  • TO subnet (PARENT of ip-address-list, ip-address-list BelongsTo subnet, MANY2ONE)(4)
  • TO vip-ipv4-address-list( ip-address-list Uses vip-ipv4-address-list, ONE2ONE)

    • 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

  • TO vip-ipv6-address-list( ip-address-list Uses vip-ipv6-address-list, ONE2ONE)

    • 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

  • (4) IF this TO node is deleted, this IP-ADDRESS-LIST is DELETED also
ip-address: string

IP address

ip-address-end: string

IP address end range

ip-version: string

ip version, either 4 or 6

type: string

reserved, static, dhcp

assignment: string
operator: string

Operator to apply to the port (greater than, less than, etc).

length: integer

ip-address prefix length, 32 for single address.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

ipsec-configuration: object

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

  • FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
  • FROM vig-server (CHILD of ipsec-configuration, vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)

  • (1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
ipsec-configuration-id: string

UUID of this configuration

requested-vig-address-type: string

Indicate the type of VIG server like AVPN, INTERNET, BOTH

requested-encryption-strength: string

Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc

requested-dmz-type: string

Shared DMZ or a DMZ specific to a customer

shared-dmz-network-address: string

Network address of shared DMZ

requested-customer-name: string

If the DMZ is a custom DMZ, this field will indicate the customer information

ike-version: string

can be 1 or 2

ikev1-authentication: string

Contains values like md5, sha1, sha256, sha384

ikev1-encryption: string

Encyption values like 3des-cbc, des-cbc, aes-128-cbc,aes-192-cbc, aes-265-cbc

ikev1-dh-group: string

Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14

ikev1-am-group-id: string

Group name defined in VIG for clients using aggressive mode

ikev1-am-password: string

pre-shared key for the above group name

ikev1-sa-lifetime: string

Lifetime for IKEv1 SA

ipsec-authentication: string

md5, sha1, sha256, sha384

ipsec-encryption: string

3des-cbc, des-cbc, aes-128-cbc,aes-192-cbc, aes-265-cbc

ipsec-sa-lifetime: string

Life time for IPSec SA

ipsec-pfs: string

enable PFS or not

xauth-userid: string

user ID for xAuth, sm-user,ucpeHostName,nmteHostName

xauth-user-password: string

Encrypted using the Juniper $9$ algorithm

dpd-interval: string

The time between DPD probe

dpd-frequency: string

Maximum number of DPD before claiming the tunnel is down

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship
vig-servers: object[]
vig-server

ipsec-configurations: object

ipsec-configuration: object[]
ipsec-configuration

k8s-resource: object

General purpose kubernetes resource.

  • TO tenant (PARENT of k8s-resource, k8s-resource BelongsTo tenant, MANY2ONE)
  • FROM generic-vnf( generic-vnf HostedOn k8s-resource, ONE2MANY)
  • FROM vf-module( vf-module Uses k8s-resource, ONE2MANY)
id: string

Unique id of k8s resource. This is unique across the graph.

name: string

Name of the kubernetes resource.

group: string

Kubernetes resource group.

version: string

Resource version.

kind: string

Resource kind as defined by kubernetes e.g. pod, service, etc.

namespace: string

Namespace in which resource is placed.

labels: string

Kubernetes resource labels.

selflink: string

Query towards SO CNF adapter to retrieve full resource data.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

k8s-resources: object

Collection of kubernetes resources.

k8s-resource: object[]
k8s-resource

key-data: object

key-name: string
key-value: string

l-interface: object

Logical interfaces, e.g., a vnic.

  • TO cp( l-interface LinksTo cp, ONE2ONE)
  • TO generic-vnf (PARENT of l-interface, l-interface BelongsTo generic-vnf, MANY2ONE)(4)
  • TO instance-group( l-interface MemberOf instance-group, MANY2MANY)
  • TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
  • TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
  • TO newvce (PARENT of l-interface, l-interface BelongsTo newvce, MANY2ONE)(4)
  • TO next-hop( l-interface Uses next-hop, ONE2MANY)

    • The l-interface that is used by the next-hop.

  • TO object-group( l-interface MemberOf object-group, ONE2MANY)

    • Member of l-interface

  • TO p-interface (PARENT of l-interface, l-interface BindsTo p-interface, MANY2ONE)(4)
  • TO pnf (PARENT of l-interface, l-interface BelongsTo pnf, MANY2ONE)

    • A logical interface associated with a pnf.(4)

  • TO pserver (PARENT of l-interface, l-interface BelongsTo pserver, MANY2ONE)

    • A logical interface associated with a pserver.(4)

  • TO vlan-tag( l-interface Uses vlan-tag, MANY2MANY)

    • An sub-interface that uses a vlan-tag.

  • TO vserver (PARENT of l-interface, l-interface BindsTo vserver, MANY2ONE)(4)
  • TO lag-interface (PARENT of l-interface, l-interface BelongsTo lag-interface, MANY2ONE)(4)
  • FROM allotted-resource( allotted-resource Uses l-interface, ONE2MANY)
  • FROM configuration( configuration AppliesTo l-interface, MANY2MANY)
  • FROM forwarder( forwarder ForwardsTo l-interface, MANY2MANY)
  • FROM l-interface (PARENT of l-interface, l-interface BelongsTo l-interface, MANY2ONE)(4)
  • FROM logical-link( logical-link Source l-interface, MANY2MANY)(1)
  • FROM logical-link( logical-link Destination l-interface, MANY2MANY)(1)
  • FROM policy( policy AppliesTo l-interface, MANY2MANY)

    • The policy applies to an l-interface.

  • FROM profile( profile AppliesTo l-interface, MANY2MANY)

    • A profile (set of characteristics) applies to the l-interface.

  • FROM sriov-vf (CHILD of l-interface, sriov-vf BelongsTo l-interface, ONE2ONE)(1)
  • FROM temporary-parameter-list (CHILD of l-interface, temporary-parameter-list BindsTo l-interface, MANY2ONE)

    • used for generic interface parameters(1)

  • FROM vlan (CHILD of l-interface, vlan LinksTo l-interface, MANY2ONE)(1)
  • FROM vrf( vrf Uses l-interface, ONE2MANY)
  • FROM l3-interface-ipv4-address-list (CHILD of l-interface, l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
  • FROM l3-interface-ipv6-address-list (CHILD of l-interface, l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
  • FROM lag-interface( lag-interface Uses l-interface, MANY2MANY)
  • FROM lcmp-unreachable (CHILD of l-interface, lcmp-unreachable BindsTo l-interface, ONE2ONE)

    • used for generic interface(1)

  • (1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
  • (2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
  • (4) IF this TO node is deleted, this L-INTERFACE is DELETED also
interface-name: string

Name given to the interface

interface-role: string

E.g., CUSTOMER, UPLINK, etc.

v6-wan-link-ip: string

Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.

selflink: string

URL to endpoint where AAI can get more details

interface-id: string

ID of interface

macaddr: string

MAC address for the interface

network-name: string

Name of the network

management-option: string

Whether A&AI should be managing this interface of not. Could have value like CUSTOMER

interface-description: string

Human friendly text regarding this interface.

interface-type: string

type to sub-classify the l-interface (ex, loopback)

is-port-mirrored: boolean

boolean indicatating whether or not port is a mirrored.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

in-maint: boolean

used to indicate whether or not this object is in maintenance mode (maintenance mode = true)

prov-status: string

Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].

is-ip-unnumbered: boolean

Flag indicating the interface uses the IP Unnumbered configuration.

allowed-address-pairs: string

Freeform field for storing an ip address, list of ip addresses or a subnet block.

priority: integer

Priority used for fail-over. Valid values 1-1024, with 1 being the highest priority.

ops-note: string

Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.

interface-function: string

The function performed by this Linterface

l2-multicasting: boolean

Identifies l2-multicasting support on an l-interface. true indicates that l2-multicasting is supported; defaulted to false .

vlan-id-statement-needed: string

indicates whether the vlan-id-statement needs to be configured for the interface.

encapsulation: string

specifies the encapsulation type

transport-type: string

specifies the transport type, e.g. L2transport

encapsulation-tag-rewrite: string

used to store the re-write command, e.g.rewrite ingress tag pop 1 symmetric

mtu: string

Maximum transmission unit (MTU) is used to determine the maximum size of each packet in any TCP or IP transmission.

load-interval: string

Length of time for which data is used to compute load statistics.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

admin-status: string

Administrative status of the interface. Valid values are 'up', 'down', or 'testing'.

vlans: object[]
vlan
sriov-vfs: object[]
sriov-vf
l-interfaces: object[]
l-interface
temporary-parameter-lists: object[]
temporary-parameter-list
lcmp-unreachables: object[]
lcmp-unreachable
relationship-list: object
relationship
l3-interface-ipv4-address-list: object[]
l3-interface-ipv4-address-list
l3-interface-ipv6-address-list: object[]
l3-interface-ipv6-address-list

l-interfaces: object

Collection of logical interfaces.

l-interface: object[]
l-interface

l3-interface-ipv4-address-list: object

IPv4 Address Range

  • TO cp (PARENT of l3-interface-ipv4-address-list, l3-interface-ipv4-address-list BelongsTo cp, MANY2ONE)(4)
  • TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
  • TO l-interface (PARENT of l3-interface-ipv4-address-list, l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
  • TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
  • TO lag-interface (PARENT of l3-interface-ipv4-address-list, l3-interface-ipv4-address-list BelongsTo lag-interface, MANY2ONE)

    • A IPv4 address associated with a lag-interface.(4)

  • TO p-interface (PARENT of l3-interface-ipv4-address-list, l3-interface-ipv4-address-list BelongsTo p-interface, MANY2ONE)

    • A IPv4 address associated with a p-interface.(4)

  • TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
  • TO vlan (PARENT of l3-interface-ipv4-address-list, l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
  • TO vnfc (PARENT of l3-interface-ipv4-address-list, l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(4)
  • FROM bgp-group( bgp-group Destination l3-interface-ipv4-address-list, MANY2ONE)

    • To node-type is destination of bgp-group.

  • FROM bgp-group( bgp-group Source l3-interface-ipv4-address-list, MANY2ONE)

    • To node-type is source of bgp-group.

  • FROM bgp-neighbor( bgp-neighbor Uses l3-interface-ipv4-address-list, MANY2ONE)

    • bgp-neighbor uses To node-type.

  • FROM fqdn( fqdn AppliesTo l3-interface-ipv4-address-list, ONE2ONE)

    • The fqdn that applies to a l3-interface-ipv4-address-list.

  • FROM ip-address-list( ip-address-list Uses l3-interface-ipv4-address-list, ONE2ONE)

    • 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

  • (4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
  • L3-INTERFACE-IPV4-ADDRESS-LIST cannot be deleted if related to BGP-GROUP,BGP-NEIGHBOR,IP-ADDRESS-LIST
l3-interface-ipv4-address: string

IP address

l3-interface-ipv4-prefix-length: integer

Prefix length, 32 for single address

vlan-id-inner: integer

Inner VLAN tag

vlan-id-outer: integer

Outer VLAN tag

is-floating: boolean

Indicator of fixed or floating address

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

neutron-network-id: string

Neutron network id of the interface that address belongs to

neutron-subnet-id: string

Neutron id of subnet that address belongs to

ops-note: string

Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

l3-interface-ipv6-address-list: object

IPv6 Address Range

  • TO cp (PARENT of l3-interface-ipv6-address-list, l3-interface-ipv6-address-list BelongsTo cp, MANY2ONE)(4)
  • TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
  • TO l-interface (PARENT of l3-interface-ipv6-address-list, l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
  • TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
  • TO lag-interface (PARENT of l3-interface-ipv6-address-list, l3-interface-ipv6-address-list BelongsTo lag-interface, MANY2ONE)

    • A IPv6 address associated with a lag-interface.(4)

  • TO p-interface (PARENT of l3-interface-ipv6-address-list, l3-interface-ipv6-address-list BelongsTo p-interface, MANY2ONE)

    • A IPv6 address associated with a p-interface.(4)

  • TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
  • TO vlan (PARENT of l3-interface-ipv6-address-list, l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
  • TO vnfc (PARENT of l3-interface-ipv6-address-list, l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(4)
  • FROM bgp-group( bgp-group Destination l3-interface-ipv6-address-list, MANY2ONE)

    • To node-type is destination of bgp-group.

  • FROM bgp-group( bgp-group Source l3-interface-ipv6-address-list, MANY2ONE)

    • To node-type is source of bgp-group.

  • FROM bgp-neighbor( bgp-neighbor Uses l3-interface-ipv6-address-list, MANY2ONE)

    • bgp-neighbor uses To node-type.

  • FROM fqdn( fqdn AppliesTo l3-interface-ipv6-address-list, ONE2ONE)

    • The fqdn that applies to a l3-interface-ipv6-address-list.

  • FROM ip-address-list( ip-address-list Uses l3-interface-ipv6-address-list, ONE2ONE)

    • 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

  • (4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
  • L3-INTERFACE-IPV6-ADDRESS-LIST cannot be deleted if related to BGP-GROUP,BGP-NEIGHBOR,IP-ADDRESS-LIST
l3-interface-ipv6-address: string

IP address

l3-interface-ipv6-prefix-length: integer

Prefix length, 128 for single address

vlan-id-inner: integer

Inner VLAN tag

vlan-id-outer: integer

Outer VLAN tag

is-floating: boolean

Indicator of fixed or floating address

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

neutron-network-id: string

Neutron network id of the interface that address belongs to

neutron-subnet-id: string

Neutron id of subnet that address belongs to

ops-note: string

Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

l3-network: object

Generic network definition

  • TO cp( l3-network LinksTo cp, MANY2MANY)
  • TO instance-group( l3-network MemberOf instance-group, MANY2MANY)
  • TO l3-network( l3-network Uses l3-network, MANY2MANY)

    • l3-network uses l3-network

  • TO network-policy( l3-network Uses network-policy, MANY2MANY)
  • TO network-route( l3-network Uses network-route, MANY2MANY)

    • Relates l3-network to network-route for static routes.

  • TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
  • TO vlan-tag( l3-network Uses vlan-tag, MANY2MANY)

    • A l3-network Uses vlan-tag.

  • TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
  • FROM aggregate-route (CHILD of l3-network, aggregate-route BelongsTo l3-network, MANY2ONE)(1)
  • FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
  • FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
  • FROM complex( complex Uses l3-network, MANY2MANY)
  • FROM configuration( configuration PartOf l3-network, MANY2MANY)
  • FROM ctag-assignment (CHILD of l3-network, ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
  • FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
  • FROM l3-network( l3-network Uses l3-network, MANY2MANY)

    • l3-network uses l3-network

  • FROM line-of-business( line-of-business Uses l3-network, MANY2MANY)
  • FROM platform( platform Uses l3-network, MANY2MANY)
  • FROM policy( policy AppliesTo l3-network, MANY2MANY)

    • A policy applies to l3-networks.

  • FROM profile( profile AppliesTo l3-network, MANY2MANY)

    • A profile (set of characteristics) applies to the l3-network.

  • FROM segmentation-assignment (CHILD of l3-network, segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
  • FROM service-instance( service-instance ComposedOf l3-network, MANY2MANY)
  • FROM subnet (CHILD of l3-network, subnet BelongsTo l3-network, MANY2ONE)(1)
  • FROM tenant( tenant Uses l3-network, MANY2MANY)
  • FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
  • FROM vrf( vrf Uses l3-network, ONE2MANY)

    • A vrf uses many l3-networks

  • (1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
  • L3-NETWORK cannot be deleted if related to NETWORK-ROUTE
network-id: string

Network ID, should be uuid. Unique across A&AI.

network-name: string

Name of the network, governed by some naming convention..

network-type: string

Type of the network - who defines these values?

network-role: string

Role the network plans - who defines these values?

network-technology: string

Network technology - who defines these values?

description: string

text used for documentation

neutron-network-id: string

Neutron network id of this Interface

is-bound-to-vpn: boolean

Set to true if bound to VPN

service-id: string

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

network-role-instance: integer

network role instance

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

orchestration-status: string

Orchestration status of this VNF, mastered by MSO

heat-stack-id: string

Heat stack id corresponding to this instance, managed by MSO

mso-catalog-key: string

Corresponds to the SDN-C catalog id used to configure this VCE

contrail-network-fqdn: string

Contrail FQDN for the network

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

persona-model-version: string

the ASDC model version for this resource or service model.

model-customization-id: string

captures the id of all the configuration used to customize the resource for the service.

widget-model-id: string

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

widget-model-version: string

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

physical-network-name: string

Name associated with the physical network.

is-provider-network: boolean

boolean indicatating whether or not network is a provider network.

is-shared-network: boolean

boolean indicatating whether or not network is a shared network.

is-external-network: boolean

boolean indicatating whether or not network is an external network.

selflink: string

Path to the controller object.

operational-status: string

Indicator for whether the resource is considered operational.

is-trunked: boolean

Trunked network indication.

ops-note: string

Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.

network-function: string

The function performed by this l3 network

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

subnets: object[]
subnet
ctag-assignments: object[]
ctag-assignment
segmentation-assignments: object[]
segmentation-assignment
aggregate-routes: object[]
aggregate-route
relationship-list: object
relationship

l3-networks: object

l3-network: object[]
l3-network

label-restriction: object

Instance of an label restriction

  • TO te-link-attribute( label-restriction LinksTo te-link-attribute, MANY2MANY)

    • For CCVPN Usecase(4)

  • (4) IF this TO node is deleted, this LABEL-RESTRICTION is DELETED also
id: string

Id that identifies the label restriction

label-start: integer

First number in the label range

label-end: integer

Last number in the label range

range-bitmap: string

Bitmap of available labels starting from label-start to label-end.

label-step: integer

Step of labels in label range.

inclusive-exclusive: string

Indicate wheather range-bitmap items are inclusive or exclusive.

range-type: string

Indicate the label range e.g.trib-slot, trib-port

trib-slot-granularity: string

Indicate trib slot granularity.

priority: integer

Priority.

selflink: string

Store the link to get more information for this object.

operational-status: string

Store the operational-status for this object.

model-customization-id: string

Store the model-customization-id for this object.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

label-restrictions: object

Collection of Label Restriction.

label-restriction: object[]
label-restriction

lacp: object

Used to specify Link Aggregation Control Protocol attributes.

  • TO aggregated-ether-option (PARENT of lacp, lacp BindsTo aggregated-ether-option, ONE2ONE)

    • used for generic interface parameters(4)

  • (4) IF this TO node is deleted, this LACP is DELETED also
lacp-id: string

UUID- unique object identifier

system-id: string

LACP system identifier at the aggregated Ethernet interface level

mode: string

specifies the state of the interface

periodic: string

periodic transmission rate

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

lacps: object

Collection of lacps.

lacp: object[]
lacp

lag-interface: object

Link aggregate interface

  • TO generic-vnf (PARENT of lag-interface, lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
  • TO geo-region( lag-interface MemberOf geo-region, MANY2MANY)

    • The lag-interface associated to a geo-region

  • TO l-interface( lag-interface Uses l-interface, MANY2MANY)
  • TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
  • TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2)
  • TO p-interface( lag-interface Uses p-interface, MANY2MANY)
  • TO pnf (PARENT of lag-interface, lag-interface BindsTo pnf, MANY2ONE)(4)
  • TO pserver (PARENT of lag-interface, lag-interface BindsTo pserver, MANY2ONE)(4)
  • TO vpls-pe (PARENT of lag-interface, lag-interface BindsTo vpls-pe, MANY2ONE)(4)
  • FROM aggregated-ether-option (CHILD of lag-interface, aggregated-ether-option BindsTo lag-interface, ONE2ONE)

    • used for generic interface parameters(1)

  • FROM configuration( configuration AppliesTo lag-interface, MANY2ONE)
  • FROM esi (CHILD of lag-interface, esi BindsTo lag-interface, ONE2ONE)

    • used for generic interface parameters(1)

  • FROM forwarder( forwarder ForwardsTo lag-interface, MANY2MANY)
  • FROM l3-interface-ipv4-address-list (CHILD of lag-interface, l3-interface-ipv4-address-list BelongsTo lag-interface, MANY2ONE)

    • A IPv4 address associated with a lag-interface.(1)

  • FROM l3-interface-ipv6-address-list (CHILD of lag-interface, l3-interface-ipv6-address-list BelongsTo lag-interface, MANY2ONE)

    • A IPv6 address associated with a lag-interface.(1)

  • FROM l-interface (CHILD of lag-interface, l-interface BelongsTo lag-interface, MANY2ONE)(1)
  • FROM policy( policy AppliesTo lag-interface, MANY2MANY)

    • used to support NCX-Hub

  • FROM profile( profile AppliesTo lag-interface, MANY2MANY)

    • A profile (set of characteristics) applies to the lag-interface.

  • FROM temporary-parameter-list (CHILD of lag-interface, temporary-parameter-list BindsTo lag-interface, MANY2ONE)

    • used for generic interface parameters(1)

  • (1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
  • (2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
  • (4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
interface-name: string

Name that identifies the link aggregate interface

interface-description: string

Human friendly text regarding this interface.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

speed-value: string

Captures the numeric part of the speed

speed-units: string

Captures the units corresponding to the speed

interface-id: string

ID of interface

interface-role: string

Role assigned to this Interface, should use values as defined in ONAP Yang models.

prov-status: string

Trigger for operational monitoring of this resource by Service Assurance systems.

in-maint: boolean

used to indicate whether or not this object is in maintenance mode (maintenance mode = true)

lacp-system-id: string

The system id used by the LACP protocol.

ops-note: string

Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.

interface-function: string

The function performed by this Lag interface

min-links: integer

Minimum links in service before a LAG should be taken out of service

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

interface-type: string

Used to identify the type of lag-interface.

encapsulation: string

specifies the encapsulation type

flexible-vlan-tagging: string

Specifies support for simultaneous transmission of 802.1Q VLAN single-tag and dual-tag frames on logical interfaces on the same Ethernet port, and on pseudowire logical interfaces.

mtu: string

Maximum transmission unit (MTU) is used to determine the maximum size of each packet in any TCP or IP transmission.

load-interval: string

Length of time for which data is used to compute load statistics.

logging-event: string

Enables system logging of interface state-change events Values, * NULL (not enabled/configured) Link-status future options, i.e. default, enable, trunk-status.

dampening: string

throttles interface flapping events to prevent excessive churn and processing of routing tables. Values, NULL (dampening not configured DEFAULT (dampening w/o options) configures as dampening dampening options configures dampening w/ options

relationship-list: object
relationship
l-interfaces: object[]
l-interface
aggregated-ether-options: object[]
aggregated-ether-option
temporary-parameter-lists: object[]
temporary-parameter-list
esis: object[]
esi
l3-interface-ipv4-address-list: object[]
l3-interface-ipv4-address-list
l3-interface-ipv6-address-list: object[]
l3-interface-ipv6-address-list

lag-interfaces: object

Collection of link aggregate interfaces.

lag-interface: object[]
lag-interface

lan-port-config: object

Instance of a lan-port-config

  • TO dhcp-service (PARENT of lan-port-config, lan-port-config Uses dhcp-service, ONE2MANY)

    • For CCVPN Usecase(2)

  • TO ext-aai-network( lan-port-config BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • TO generic-vnf( lan-port-config PartOf generic-vnf, MANY2MANY)

    • For CCVPN Usecase

  • TO service-instance( lan-port-config PartOf service-instance, ONE2MANY)

    • For CCVPN Usecase

  • (2) IF this LAN-PORT-CONFIG node is deleted, this TO node is DELETED also
lan-port-config-id: string

Uniquely identifies this lan-port-config by id

lan-port-config-name: string

Store the name of this lan-port-config.

description: string

Store the description of this lan-port-config.

device-id: string

Store the device-id of this lan-port-config.

port-id: string

Store the port-id of this lan-port-config.

ipv4-address: string

Store the ipv4-address of this lan-port-config.

ipv6-address: string

Store the ipv6-address of this lan-port-config.

vlan-tag: string

Store the vlan-tag of this lan-port-config.

input-bandwidth: string

Store the input-bandwidth of this lan-port-config.

output-bandwidth: string

Store the output-bandwidth of this lan-port-config.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

dhcp-services: object[]
dhcp-service
relationship-list: object
relationship

lan-port-configs: object

Collection of lan-port-configs

lan-port-config: object[]
lan-port-config

lcmp-unreachable: object

Flag to indicate generation of Internet Control Message Protocol (ICMP) unreachable messages

  • TO l-interface (PARENT of lcmp-unreachable, lcmp-unreachable BindsTo l-interface, ONE2ONE)

    • used for generic interface(4)

  • (4) IF this TO node is deleted, this LCMP-UNREACHABLE is DELETED also
lcmp-unreachable-id: string

object identifier

af-ipv4: string

Flag to indicate generation of Internet Control Message Protocol (ICMP) unreachable messages for ipv4 address family Values, null, disable, enable

af-ipv6: string

Flag to indicate generation of Internet Control Message Protocol (ICMP) unreachable messages for ipv6 address family Values, null, disable, enable

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

lcmp-unreachables: object

Collection of lcmp unreachables.

lcmp-unreachable: object[]
lcmp-unreachable

license: object

Metadata for license group.

  • TO chassis (PARENT of license, license BelongsTo chassis, MANY2ONE)

    • A license belongs to a chassis.(4)

  • TO generic-vnf (PARENT of license, license BelongsTo generic-vnf, MANY2ONE)(4)
  • TO vce (PARENT of license, license BelongsTo vce, MANY2ONE)(4)

  • (4) IF this TO node is deleted, this LICENSE is DELETED also
group-uuid: string

Unique ID for the license group the resource belongs to, should be uuid.

resource-uuid: string

Unique ID of a license resource.

project-number: string

Used to store CFAS or other project numbers.

order-number: string

Order number.

receipt-date: string

Date of receipt.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Concurrency value

relationship-list: object
relationship

licenses: object

Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management

license: object[]
license

line-of-business: object

describes a line-of-business

  • TO cloud-region( line-of-business Uses cloud-region, MANY2MANY)
  • TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
  • TO l3-network( line-of-business Uses l3-network, MANY2MANY)
  • TO tenant( line-of-business Uses tenant, MANY2MANY)
  • TO vlan-range( line-of-business Uses vlan-range, ONE2MANY)

    • A line-of uses a vlan-range

  • FROM validation-audit( validation-audit AppliesTo line-of-business, MANY2ONE)

    • The line-of-business associated to a validation-audit

line-of-business-name: string

Name of the line-of-business (product)

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

lines-of-business: object

Collection of lines-of-business

line-of-business: object[]
line-of-business

mapping: object

General mechanism for mapping between instances; cg-nat.

  • TO cloud-region( mapping LocatedIn cloud-region, MANY2MANY)

    • The mapping associated to a cloud-region

  • TO instance-group( mapping Current instance-group, MANY2MANY)
  • TO instance-group( mapping MemberOf instance-group, MANY2MANY)

    • The mapping associated to an instance-group

  • TO instance-group( mapping Target instance-group, MANY2MANY)
  • TO mapping( mapping AppliesTo mapping, MANY2MANY)

    • The mapping associated to a mapping

  • TO mapping( mapping MemberOf mapping, MANY2MANY)

    • The mapping associated to a mapping

  • TO object-group( mapping MemberOf object-group, ONE2MANY)

    • The mapping associated to an object-group

  • TO pnf( mapping MemberOf pnf, ONE2MANY)

    • The mapping associated to a pnf

  • TO policy( mapping MemberOf policy, ONE2MANY)

    • The mapping associated to a policy

  • FROM activity( activity AppliesTo mapping, MANY2MANY)

    • The reservation information associated with a NAT Pool mapping.

  • FROM mapping( mapping AppliesTo mapping, MANY2MANY)

    • The mapping associated to a mapping

  • FROM mapping( mapping MemberOf mapping, MANY2MANY)

    • The mapping associated to a mapping

mapping-id: string

Key for mapping object.

mapping-name: string

Name of mapping

mapping-type: string

Type of mapping.

mapping-role: string

Role of mapping

mapping-function: string

Function of mapping

mapping-number: string

Number of mapping

location-1: string

Location 1

location-2: string

Location 2

mapping-group-id: string

Non-unique ID for grouping mappings

prov-status: string

Provision status for the mapping object. Valid values [PREPROV/NVTPROV/PROV].

homed-location: string

Location the object is homed to

planned-location: string

Location the object is planned for

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string
relationship-list: object
relationship

mappings: object

Collection of mappings.

mapping: object[]
mapping

metadata: object

Collection of metadatum (key/value pairs)

metadatum: object[]
metadatum

metadatum: object

Key/value pairs

  • TO configuration (PARENT of metadatum, metadatum BelongsTo configuration, MANY2ONE)(4)
  • TO connector (PARENT of metadatum, metadatum BelongsTo connector, MANY2ONE)(4)
  • TO cp( metadatum AppliesTo cp, MANY2MANY)

    • AAI-2154 For BBS Usecase

  • TO generic-vnf( metadatum AppliesTo generic-vnf, MANY2MANY)

    • AAI-2154 For BBS Usecase

  • TO image (PARENT of metadatum, metadatum BelongsTo image, MANY2ONE)(4)
  • TO model-ver (PARENT of metadatum, metadatum BelongsTo model-ver, MANY2ONE)(4)
  • TO pnf( metadatum AppliesTo pnf, MANY2MANY)

    • AAI-2154 For BBS Usecase

  • TO profile (PARENT of metadatum, metadatum BelongsTo profile, MANY2ONE)(4)
  • TO rule (PARENT of metadatum, metadatum BelongsTo rule, MANY2ONE)(4)
  • TO service-instance (PARENT of metadatum, metadatum BelongsTo service-instance, MANY2ONE)(4)

  • (4) IF this TO node is deleted, this METADATUM is DELETED also
metaname: string
metaval: string
data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

model: object

Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version

  • FROM instance-group( instance-group Targets model, MANY2MANY)
  • FROM model-ver (CHILD of model, model-ver BelongsTo model, MANY2ONE)(1)
  • FROM named-query( named-query AppliesTo model, ONE2MANY)
  • FROM named-query-element( named-query-element IsA model, MANY2ONE)

  • (1) IF this MODEL node is deleted, this FROM node is DELETED also
  • MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
model-invariant-id: string

Unique identifier corresponding to the main definition of a model in ASDC

model-type: string

Type of the model, e.g., service, resource, widget, etc.

model-role: string

Role of the model,e.g.,NST,NSST,CST,etc

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

model-vers: object[]
model-ver
relationship-list: object
relationship

model-constraint: object

This is how we would capture constraints defining allowed sets of elements.

  • TO model-element (PARENT of model-constraint, model-constraint BelongsTo model-element, MANY2ONE)(4)
  • FROM constrained-element-set (CHILD of model-constraint, constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)

  • (1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
model-constraint-uuid: string
data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

constrained-element-set-uuid-to-replace: string
resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

constrained-element-sets: object[]
constrained-element-set

model-constraints: object

model-constraint: object[]
model-constraint

model-element: object

Defines how other models combine to make up a higher-level model.

  • TO element-choice-set (PARENT of model-element, model-element BelongsTo element-choice-set, MANY2ONE)(4)
  • TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
  • TO model-ver( model-element IsA model-ver, MANY2ONE)
  • TO model-ver (PARENT of model-element, model-element BelongsTo model-ver, MANY2ONE)(4)
  • FROM constrained-element-set (CHILD of model-element, constrained-element-set BelongsTo model-element, MANY2ONE)(1)
  • FROM model-constraint (CHILD of model-element, model-constraint BelongsTo model-element, MANY2ONE)(1)
  • FROM model-element (PARENT of model-element, model-element BelongsTo model-element, MANY2ONE)(4)

  • (1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
model-element-uuid: string
new-data-del-flag: string

Indicates whether this element was created as part of instantiation from this model

cardinality: string

How many of this type of element are required/allowed

linkage-points: string
resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

model-elements: object[]
model-element
model-constraints: object[]
model-constraint
relationship-list: object
relationship

model-elements: object

model-element: object[]
model-element

model-ver: object

Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models

  • TO model (PARENT of model-ver, model-ver BelongsTo model, MANY2ONE)(4)
  • FROM metadatum (CHILD of model-ver, metadatum BelongsTo model-ver, MANY2ONE)(1)
  • FROM model-element( model-element IsA model-ver, MANY2ONE)
  • FROM model-element (CHILD of model-ver, model-element BelongsTo model-ver, MANY2ONE)(1)

  • (1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this MODEL-VER is DELETED also
  • MODEL-VER cannot be deleted if related to MODEL-ELEMENT
model-version-id: string

Unique identifier corresponding to one version of a model in ASDC

model-name: string

Name of the model, which can change from version to version.

model-version: string

Version

distribution-status: string

Distribution Status

model-description: string

Description

sdnc-model-name: string

The CDS blue print name associated with the resource.

sdnc-model-version: string

The version of the CDS blue print.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

model-elements: object[]
model-element
metadata: object[]
metadatum
relationship-list: object
relationship

model-vers: object

model-ver: object[]
model-ver

models: object

Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models

model: object[]
model

multicast-configuration: object

Groups different VLANs that are on different logical interfaces on the same VNF. Multicast is the delivery of information to a group of destinations simultaneously, using the most efficient strategy to deliver messages over each link of the network only once, and create copies only when the links to the destinations split.

  • FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
multicast-configuration-id: string

Unique id of multicast configuration.

multicast-protocol: string

protocol of multicast configuration

rp-type: string

rp type of multicast configuration

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

multicast-configurations: object

multicast configuration of generic-vnf ip-address

multicast-configuration: object[]
multicast-configuration

named-queries: object

named-query: object[]
named-query

named-query: object

TBD

  • TO model( named-query AppliesTo model, ONE2MANY)
  • FROM named-query-element (CHILD of named-query, named-query-element BelongsTo named-query, ONE2ONE)(1)

  • (1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
named-query-uuid: string
named-query-name: string
named-query-version: string
required-input-param: string
description: string
resource-version: string
named-query-elements: object[]
named-query-element
relationship-list: object
relationship

named-query-element: object

TBD

  • TO model( named-query-element IsA model, MANY2ONE)
  • TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
  • TO named-query (PARENT of named-query-element, named-query-element BelongsTo named-query, ONE2ONE)(4)
  • FROM named-query-element (PARENT of named-query-element, named-query-element BelongsTo named-query-element, MANY2ONE)(4)
  • FROM property-constraint (CHILD of named-query-element, property-constraint BelongsTo named-query-element, MANY2ONE)(1)
  • FROM related-lookup (CHILD of named-query-element, related-lookup BelongsTo named-query-element, MANY2ONE)(1)

  • (1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
named-query-element-uuid: string
property-collect-list: string
resource-version: string
property-limit-desc: string
do-not-output: string
named-query-elements: object[]
named-query-element
related-lookups: object[]
related-lookup
property-constraints: object[]
property-constraint
relationship-list: object
relationship

named-query-elements: object

named-query-element: object[]
named-query-element

network: object

Namespace for network inventory resources.

logical-links: object[]
logical-link
site-pair-sets: object[]
site-pair-set
vpn-bindings: object[]
vpn-binding
vpls-pes: object[]
vpls-pe
multicast-configurations: object[]
multicast-configuration
vces: object[]
vce
vnfcs: object[]
vnfc
l3-networks: object[]
l3-network
network-policies: object[]
network-policy
generic-vnfs: object[]
generic-vnf
lag-links: object[]
lag-link
newvces: object[]
newvce
pnfs: object[]
pnf
chassies: object[]
chassis
physical-links: object[]
physical-link
ipsec-configurations: object[]
ipsec-configuration
route-table-references: object[]
route-table-reference
instance-groups: object[]
instance-group
zones: object[]
zone
autonomous-systems: object[]
autonomous-system
network-ranges: object[]
network-range
mappings: object[]
mapping
hw-components: object[]
hw-component
sw-components: object[]
sw-component
network-routes: object[]
network-route
configurations: object[]
configuration
forwarding-paths: object[]
forwarding-path
collections: object[]
collection
next-hops: object[]
next-hop
bfds: object[]
bfd
fqdns: object[]
fqdn
connectivities: object[]
connectivity
lan-port-configs: object[]
lan-port-config
network-resources: object[]
network-resource
site-resources: object[]
site-resource
sdwan-vpns: object[]
sdwan-vpn
devices: object[]
device
wan-port-configs: object[]
wan-port-config
ext-aai-networks: object[]
ext-aai-network
label-restrictions: object[]
label-restriction
unis: object[]
uni
te-link-attributes: object[]
te-link-attribute
interlayer-attachments: object[]
interlayer-attachment
tunnel-termination-points: object[]
tunnel-termination-point

network-policies: object

network-policy: object[]
network-policy

network-policy: object

Captures set of conditions, constraints, and settings that allow designation of who is authorized to connect to the network and the circumstances under which they can or cannot connect. Provides Contrail FQDN for policy.

  • FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE)
  • FROM l3-network( l3-network Uses network-policy, MANY2MANY)
network-policy-id: string

UUID representing unique key to this instance

network-policy-fqdn: string

Contrail FQDN for the policy

heat-stack-id: string

ID for the openStack Heat instance

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

name: string

Name of the policy

type: string

Type of the policy

latency: integer

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: integer

jitter

max-bandwidth: integer

The maximum bandwidth (mb) of the connection links in a transport slice instance.

relationship-list: object
relationship

network-profile: object

Network profile populated by SDN-GP for SNMP

  • TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
nm-profile-name: string

Unique name of network profile.

community-string: string

Encrypted SNMP community string

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

network-profiles: object

Collection of network profiles

network-profile: object[]
network-profile

network-range: object

Description of Network Range

  • TO cloud-region( network-range LocatedIn cloud-region, MANY2MANY)

    • The network-range is located in a cloud-region

  • TO complex( network-range LocatedIn complex, MANY2MANY)

    • The network-range is located in a complex

  • TO zone( network-range LocatedIn zone, MANY2MANY)

    • The network-range is located in a zone

  • FROM activity (CHILD of network-range, activity BelongsTo network-range, MANY2ONE)

    • An activity is being performed on a network-range.(1)

  • (1) IF this NETWORK-RANGE node is deleted, this FROM node is DELETED also
network-range-id: string

UUID

network-range-name: string

name

network-range-type: string

type (ex, esi, vni, vni-rt, lacp-id).

network-range-role: string

role of network-range

network-range-function: string

descriptive function

start-range: string

starting range for simple network ranges.

end-range: string

end range for simple network ranges.

last-assigned: string

last assigned value for simple network ranges

range-format: string

Format Decimal, Hexadecimal, etc.

range-prefix: string

Prefix of network range.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Concurrency value

activities: object[]
activity
relationship-list: object
relationship

network-ranges: object

Collection of Network Ranges

network-range: object[]
network-range

network-resource: object

Instance of a network-resource

  • TO ext-aai-network( network-resource BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • TO vpn-binding( network-resource Uses vpn-binding, ONE2MANY)

    • For CCVPN Usecase

  • FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc BelongsTo network-resource, ONE2MANY)

    • For MDONS Usecase(3)

  • FROM pnf( pnf LinksTo network-resource, MANY2MANY)

    • For CCVPN Usecase(1)

  • (1) IF this NETWORK-RESOURCE node is deleted, this FROM node is DELETED also
  • (3) IF this FROM node is deleted, this NETWORK-RESOURCE is DELETED also
network-id: string

Uniquely identifies this network-resource by id

provider-id: string

Store the id of the provider of this network-resource.

client-id: string

Store the id of the client of this network-resource.

te-topo-id: string

Store the id of the te-topo of this network-resource.

network-resource-type: string

Type of a network topology, e.g., Ethernet, OTN, WSON.

selflink: string

Store the link to get more information for this object.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

network-resources: object

Collection of network-resources

network-resource: object[]
network-resource

network-route: object

This object represents a network route. For instance, host-route, static-route.

  • TO next-hop( network-route Uses next-hop, ONE2MANY)

    • The network-route that is used by the next-hop.

  • TO object-group( network-route MemberOf object-group, MANY2MANY)

    • The route is part of part of a route-list that is modeled in an object-group.

  • TO subnet( network-route MemberOf subnet, MANY2ONE)

    • The route is part of part of a subnet.

  • FROM configuration( configuration Uses network-route, MANY2MANY)

    • Relates configuration to network-route for static routes.

  • FROM l3-network( l3-network Uses network-route, MANY2MANY)

    • Relates l3-network to network-route for static routes.

  • FROM service-instance( service-instance ComposedOf network-route, MANY2MANY)(3)
  • FROM vrf( vrf Uses network-route, MANY2MANY)

    • Relates vrf to network-route for static routes.

  • (3) IF this FROM node is deleted, this NETWORK-ROUTE is DELETED also
  • NETWORK-ROUTE cannot be deleted if related to OBJECT-GROUP
route-id: string

unique identifier example uuid.

type: string

used to categorize this object in conjunction with role & function. The most generic category.

role: string

used to categorize this object in conjunction with type & function.

function: string

used to categorize this object in conjunction with type & role. The most specific category.

ip-address: string

ip address that of the specific network-route.

prefix-length: integer

ip-address prefix length.

logical-interface-id: string

Identity of a logical interface, e.g., VLAN ID.

next-hop: string

Could be ip-address, hostname, or service-instance.

next-hop-type: string

Should be ip-address, hostname, or service-instance to match next-hop.

metric: integer

Value that is assigned to an IP route for a particular network interface that identifies the cost that is associated with using that route.

address-family: string

whether the route address is ipv4, ipv6.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

configuration-status: string

Configuration status of the network route.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

network-routes: object

network-route: object[]
network-route

network-technologies: object

The network-technology object is used to capture the supported network technologies of a cloud-region.

network-technology: object[]
network-technology

network-technology: object

The network-technology object is used to capture the supported network technologies of a cloud-region.

  • FROM cloud-region( cloud-region Uses network-technology, MANY2MANY)
network-technology-id: string

Unique identifier of the network-technology object (UUID)

network-technology-name: string

The network-technology that a cloud-region can support. Current valid values- CONTRAIL AIC_SR_IOV OVS STANDARD-SR-IOV

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

newvce: object

This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.

  • FROM l-interface (CHILD of newvce, l-interface BelongsTo newvce, MANY2ONE)(1)

  • (1) IF this NEWVCE node is deleted, this FROM node is DELETED also
vnf-id2: string

Unique id of VNF, can't use same attribute name right now until we promote this new object

vnf-name: string

Name of VNF.

vnf-name2: string

Alternate name of VNF.

vnf-type: string

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

prov-status: string

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

operational-status: string

Indicator for whether the resource is considered operational

license-key: string

OBSOLETE - do not use

ipv4-oam-address: string

Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).

equipment-role: string

Client should send valid enumerated value.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

ipv4-loopback0-address: string

v4 Loopback0 address

orchestration-status: string

Orchestration status of this VNF, mastered by MSO.

heat-stack-id: string

Heat stack id corresponding to this instance, managed by MSO

mso-catalog-key: string

Corresponds to the SDN-C catalog id used to configure this VCE

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship
l-interfaces: object[]
l-interface

newvces: object

This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.

newvce: object[]
newvce

next-hop: object

Is among the series of routers that are connected together in a network and is the next possible destination for a data packet.

  • TO bfd( next-hop Uses bfd, ONE2ONE)
  • FROM l-interface( l-interface Uses next-hop, ONE2MANY)

    • The l-interface that is used by the next-hop.

  • FROM network-route( network-route Uses next-hop, ONE2MANY)

    • The network-route that is used by the next-hop.

  • FROM rule( rule Uses next-hop, MANY2MANY)

    • The rule that is used by the next-hop. For CG-NAT these are the ACL policies.

  • FROM vrf( vrf Uses next-hop, MANY2MANY)

    • The vrfs that are used by the next-hop.

next-hop-id: string

UUID.

next-hop-type: string

Used to categorize this object in conjunction with role & function. The most generic category.

next-hop-role: string

Used to categorize this object in conjunction with type & function.

next-hop-function: string

Used to categorize this object in conjunction with type & role. The most specific category.

sequence: integer

Sequence number.

address-family: string

Ipv4 or Ipv6.

ip-address: string

Next hop ip-address.

metric: integer

Cost that is associated with using the route.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

next-hops: object

next-hop: object[]
next-hop

nodes: object

inventory-item-data: object[]
inventory-item-data

nos-server: object

nos-server is the execution environment that will have images, certain versions of VNOS, running on it.

  • TO pserver( nos-server HostedOn pserver, ONE2ONE)
  • TO tenant (PARENT of nos-server, nos-server BelongsTo tenant, MANY2ONE)
  • FROM generic-vnf( generic-vnf HostedOn nos-server, MANY2ONE)
nos-server-id: string

Unique identifier for this nos relative to its tenant

nos-server-name: string

Name of nos

vendor: string

uCPE vendor

prov-status: string

Trigger for operational monitoring of this resource by Service Assurance systems.

nos-server-selflink: string

URL to endpoint where AAI can get more details

in-maint: boolean

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.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

nos-servers: object

nos-server is the execution environment that will have images, certain versions of VNOS, running on it.

nos-server: object[]
nos-server

notification-event: object

cambria.partition: string
notification-event-header: object
notification-event-header

notification-event-header: object

id: string
timestamp: string
source-name: string
domain: string
sequence-number: string
severity: string
event-type: string
version: string
action: string
entity-type: string
top-entity-type: string
entity-link: string
status: string

notify: object

event-id: string
node-type: string
event-trigger: string
selflink: string
key-data: object[]
key-data

oam-network: object

OAM network, to be deprecated shortly. Do not use for new purposes.

  • TO cloud-region (PARENT of oam-network, oam-network BelongsTo cloud-region, MANY2ONE)
  • TO complex( oam-network AppliesTo complex, MANY2MANY)
  • TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
network-uuid: string

UUID of the network. Unique across a cloud-region

network-name: string

Name of the network.

cvlan-tag: integer

cvlan-id

ipv4-oam-gateway-address: string

Used for VNF firewall rule so customer cannot send customer traffic over this oam network

ipv4-oam-gateway-address-prefix-length: integer

Used for VNF firewall rule so customer cannot send customer traffic over this oam network

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

oam-networks: object

Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.

oam-network: object[]
oam-network

object-group: object

describes an object-group

  • TO cloud-region( object-group LocatedIn cloud-region, MANY2MANY)

    • The object-group is located in a cloud-region

  • TO complex( object-group LocatedIn complex, MANY2MANY)

    • The object-group is located in a complex

  • TO object-group( object-group AppliesTo object-group, MANY2MANY)

    • The object-gorup that applies to an object-group

  • TO pnf( object-group AppliesTo pnf, MANY2MANY)
  • TO vrf( object-group AppliesTo vrf, MANY2MANY)

    • The object-group to VRF for various route types.

  • TO zone( object-group LocatedIn zone, MANY2MANY)

    • The object-group is located in a zone

  • FROM community-list (CHILD of object-group, community-list BelongsTo object-group, MANY2ONE)(1)
  • FROM generic-vnf( generic-vnf AppliesTo object-group, MANY2MANY)

    • A relationship that ties the device to the prefix-list/community-list.

  • FROM ip-address-list (CHILD of object-group, ip-address-list BelongsTo object-group, MANY2ONE)(1)
  • FROM l-interface( l-interface MemberOf object-group, ONE2MANY)

    • Member of l-interface

  • FROM mapping( mapping MemberOf object-group, ONE2MANY)

    • The mapping associated to an object-group

  • FROM network-route( network-route MemberOf object-group, MANY2MANY)

    • The route is part of part of a route-list that is modeled in an object-group.

  • FROM object-group( object-group AppliesTo object-group, MANY2MANY)

    • The object-gorup that applies to an object-group

  • FROM platform( platform Uses object-group, ONE2MANY)

    • Used by Auditing applications to identify appropriate audit models based on the platform associated with the given object

  • FROM policy( policy Uses object-group, MANY2MANY)
  • FROM port-list (CHILD of object-group, port-list BelongsTo object-group, MANY2ONE)(1)
  • FROM profile( profile AppliesTo object-group, MANY2MANY)

    • The profile (set of characteristics) classifies the object-group.

  • FROM relationship-rule( relationship-rule AppliesTo object-group, MANY2MANY)

    • Details relationships object-group requires

  • FROM rule( rule Uses object-group, MANY2MANY)
  • FROM rule( rule AppliesTo object-group, MANY2MANY)
  • FROM rule( rule Source object-group, MANY2MANY)
  • FROM rule( rule Destination object-group, MANY2MANY)
  • FROM selector-list (CHILD of object-group, selector-list BelongsTo object-group, MANY2ONE)(1)

  • (1) IF this OBJECT-GROUP node is deleted, this FROM node is DELETED also
  • OBJECT-GROUP cannot be deleted if related to VRF,RULE
object-group-id: string

UUID.

group-type: string

Type of object contained in the list.

group-name: string

Name of the list.

group-name2: string

Alias name for object-group

version: string

used to track the versions of the object

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

community-list: object[]
community-list
ip-address-list: object[]
ip-address-list
port-list: object[]
port-list
selector-list: object[]
selector-list
relationship-list: object
relationship

object-groups: object

Collection of object-groups

object-group: object[]
object-group

operational-environment: object

It is a logical partition of the cloud which allows to have multiple environments in the production AIC.

  • TO operational-environment( operational-environment Uses operational-environment, MANY2MANY)
  • FROM operational-environment( operational-environment Uses operational-environment, MANY2MANY)
operational-environment-id: string

UUID of an operational environment

operational-environment-name: string

Operational Environment name

operational-environment-type: string

Operational Environment Type.

operational-environment-status: string

Status

tenant-context: string

Tenant Context.

workload-context: string

Workload Context.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

operational-environments: object

a logical partition of the cloud which allows to have multiple environments in the production AIC.

operational-environment: object[]
operational-environment

overloaded-model: object

Allows for legacy POST of old-style and new-style models

model-invariant-id: string

Unique identifier corresponding to the main definition of a model in ASDC

model-name-version-id: string

Unique identifier corresponding to one version of a model in ASDC

model-type: string

Type of the model, e.g., service, resource, widget, etc.

model-name: string

Name of the model, which can change from version to version.

model-id: string

Invariant unique ID which does not change from version to version

model-version: string

Version

model-description: string

Description

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

model-vers: object
model-vers
relationship-list: object
relationship-list

owning-entities: object

Collection of owning-entities

owning-entity: object[]
owning-entity

owning-entity: object

describes an owning-entity

  • TO tenant( owning-entity Uses tenant, ONE2MANY)
  • TO vlan-range( owning-entity Uses vlan-range, ONE2MANY)

    • An owning-entity uses a vlan-range.

  • FROM pnf( pnf BelongsTo owning-entity, MANY2ONE)
  • FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
  • FROM service-instance( service-instance Uses owning-entity, MANY2ONE)

    • service-instance Uses an owning-entity

  • FROM service-instance( service-instance Uses owning-entity, MANY2ONE)

    • service-instance Uses an owning-entity

owning-entity-id: string

UUID of an owning entity

owning-entity-name: string

Owning entity name

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

p-interface: object

Physical interface (e.g., nic)

  • TO interlayer-attachment( p-interface LinksTo interlayer-attachment, MANY2MANY)

    • For CCVPN Usecase(4)

  • TO logical-link( p-interface LinksTo logical-link, MANY2MANY)(2)
  • TO pnf (PARENT of p-interface, p-interface BindsTo pnf, MANY2ONE)(4)
  • TO pserver (PARENT of p-interface, p-interface BindsTo pserver, MANY2ONE)(4)
  • TO tunnel-termination-point( p-interface BindsTo tunnel-termination-point, MANY2MANY)

    • For CCVPN Usecase(4)

  • TO vpls-pe (PARENT of p-interface, p-interface BindsTo vpls-pe, MANY2ONE)(4)
  • TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
  • FROM activity (CHILD of p-interface, activity AppliesTo p-interface, MANY2MANY)

    • The activity applies to a p-interface.(1)

  • FROM allotted-resource( allotted-resource Uses p-interface, ONE2MANY)

    • AAI-1925 For CCVPN Usecase

  • FROM bandwidth-attribute (CHILD of p-interface, bandwidth-attribute BelongsTo p-interface, MANY2ONE)

    • For MDONS usecase(1)

  • FROM forwarder( forwarder ForwardsTo p-interface, MANY2MANY)
  • FROM gig-ether-option (CHILD of p-interface, gig-ether-option BindsTo p-interface, ONE2ONE)

    • used for generic interface parameters(1)

  • FROM hold-timer (CHILD of p-interface, hold-timer BindsTo p-interface, ONE2ONE)

    • used for generic interface parameters(1)

  • FROM l-interface (CHILD of p-interface, l-interface BindsTo p-interface, MANY2ONE)(1)
  • FROM l3-interface-ipv4-address-list (CHILD of p-interface, l3-interface-ipv4-address-list BelongsTo p-interface, MANY2ONE)

    • A IPv4 address associated with a p-interface.(1)

  • FROM l3-interface-ipv6-address-list (CHILD of p-interface, l3-interface-ipv6-address-list BelongsTo p-interface, MANY2ONE)

    • A IPv6 address associated with a p-interface.(1)

  • FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
  • FROM port( port ComposedOf p-interface, MANY2MANY)

    • A port is composed of one or more p-interfaces.(3)

  • FROM profile( profile AppliesTo p-interface, MANY2MANY)

    • A profile (set of characteristics) applies to the p-interface.

  • FROM service-instance( service-instance ComposedOf p-interface, ONE2MANY)

    • For MDONS Use case

  • FROM sriov-pf (CHILD of p-interface, sriov-pf BelongsTo p-interface, ONE2ONE)(1)
  • FROM temporary-parameter-list (CHILD of p-interface, temporary-parameter-list BindsTo p-interface, MANY2ONE)

    • used for generic interface parameters(1)

  • FROM uni( uni PartOf p-interface, MANY2MANY)

    • For CCVPN Usecase

  • FROM vpn-binding( vpn-binding BindsTo p-interface, ONE2MANY)

    • For CCVPN Usecase

  • (1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
  • (2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
  • (3) IF this FROM node is deleted, this P-INTERFACE is DELETED also
  • (4) IF this TO node is deleted, this P-INTERFACE is DELETED also
interface-name: string

Name that identifies the physical interface

interface-name2: string

Alternate name that identifies the physical interface

selflink: string

URL to endpoint where AAI can get more details.

speed-value: string

Captures the numeric part of the speed

speed-units: string

Captures the units corresponding to the speed

port-description: string

Nature of the services and connectivity on this port.

domain-type: string

Domain type of the SDNC controllerr.

equipment-identifier: string

CLEI or other specification for p-interface hardware.

interface-role: string

Role specification for p-interface hardware.

interface-type: string

Indicates the physical properties of the interface.

network-interface-type: string

Indicates the physical properties of the interface.

prov-status: string

Trigger for operational monitoring of this resource by Service Assurance systems.

mac-addresss: string

MAC Address of the p-interface.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

in-maint: boolean

used to indicate whether or not this object is in maintenance mode (maintenance mode = true)

inv-status: string

inventory status

ops-note: string

Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.

interface-function: string

The function performed by this pInterface

macaddr: string

MAC address for the interface

network-ref: string

Store the network-ref of this p-interface. Derived from ietf-restconf-notification that identifies a termination-point.

transparent: string

Store the transparent value of this p-interface.

operational-status: string

oper Status of this p-interface.

inter-domain-plug-id: integer

connect interdomain link

encapsulation: string

specifies the encapsulation type

admin-state: string

At interface inventory, set to value reflecting the state at initial configuration

load-interval: string

Length of time for which data is used to compute load statistics.

lldp: string

Link Layer Discovery Protocol, link layer protocol used by network devices for advertising their identity, capabilities, and neighbors on a local area network based on IEEE 802 technology. Values, enable, disable, NULL

dampening: string

specifies the dampening configuration to slow down the operation of automation scripts executed on the device. Values, NULL (dampening not configured) DEFAULT (dampening w/o options) configures as dampening dampening options configures dampening w/ options

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

bandwidth-attributes: object[]
bandwidth-attribute
relationship-list: object
relationship
sriov-pfs: object[]
sriov-pf
l-interfaces: object[]
l-interface
activities: object[]
activity
hold-timers: object[]
hold-timer
gig-ether-options: object[]
gig-ether-option
temporary-parameter-lists: object[]
temporary-parameter-list
l3-interface-ipv4-address-list: object[]
l3-interface-ipv4-address-list
l3-interface-ipv6-address-list: object[]
l3-interface-ipv6-address-list

p-interfaces: object

Collection of physical interfaces.

p-interface: object[]
p-interface

parameter-list: object

Parameter list associated with a policy key term

  • FROM class-map-member( class-map-member Uses parameter-list, MANY2MANY)

    • class-map-member to parameter-list

  • FROM policy-key-term( policy-key-term Uses parameter-list, MANY2MANY)

    • policy-key-term to parameter-list

parameter-list-id: string

UUID

parameter-type: string

set to QoS

parameter-role: string

parameter role

parameter-function: string

parameter function

sequence-number: string

numeric indicating the sequence of the parameter

parameter-name: string

name of the parameter

parameter-value: string

numeric value

parameter-value-unit: string

unit of the value parameter, e.g. mbps, ms

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

parameter-lists: object

Collection of parameter lists.

parameter-list: object[]
parameter-list

pdu: object

Definition of pdu

  • TO hardware-catalog-item( pdu IsA hardware-catalog-item, MANY2ONE)

    • The pdu is described by the hardware-catalog-item.

  • TO rack (PARENT of pdu, pdu LocatedIn rack, MANY2ONE)

    • A pdu is located in a building (aka complex).(4)

  • TO rack-unit( pdu Uses rack-unit, ONE2MANY)

    • A pdu uses space in a rack (aka one or more rack-units).

  • FROM profile( profile AppliesTo pdu, MANY2MANY)

    • The profile (set of characteristics) applies to the pdu.

  • (4) IF this TO node is deleted, this PDU is DELETED also
pdu-name: string

A unique name for the power distribution unit.

pdu-type: string

The type of pdu.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

pdus: object

pdu: object[]
pdu

platform: object

describes a platform

  • TO endpoint( platform Uses endpoint, ONE2MANY)

    • Used by Auditing applications to identify appropriate audit models based on the platform associated with the given object

  • TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
  • TO l3-network( platform Uses l3-network, MANY2MANY)
  • TO object-group( platform Uses object-group, ONE2MANY)

    • Used by Auditing applications to identify appropriate audit models based on the platform associated with the given object

  • TO policy( platform Uses policy, ONE2MANY)

    • Used by Auditing applications to identify appropriate audit models based on the platform associated with the given object

  • TO profile( platform Uses profile, ONE2MANY)

    • Used by Auditing applications to identify appropriate audit models based on the platform associated with the given object

platform-name: string

Name of the platform

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

platforms: object

Collection of platforms

platform: object[]
platform

pluggable: object

Definition of pluggable

  • TO cable( pluggable PartOf cable, MANY2ONE)

    • A pluggable that is intergrated with a cable.(4)

  • TO hardware-catalog-item( pluggable IsA hardware-catalog-item, MANY2ONE)

    • The pluggable is described by the hardware-catalog-item.

  • TO pluggable-slot (PARENT of pluggable, pluggable LocatedIn pluggable-slot, ONE2ONE)

    • A pluggable is located in a pluggable-slot.(4)

  • FROM port (CHILD of pluggable, port LocatedIn pluggable, MANY2ONE)

    • A port is located in a pluggable.(1)

  • FROM profile( profile AppliesTo pluggable, MANY2MANY)

    • The profile (set of characteristics) applies to the pluggable.

  • (1) IF this PLUGGABLE node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this PLUGGABLE is DELETED also
pluggable-type: string

The type of pluggable.

part-number: string

Part number for this pluggable.

equip-identifier: string

CLEI or other specification for pluggable hardware.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship
ports: object[]
port

pluggable-slot: object

Definition of card-slot

  • TO card (PARENT of pluggable-slot, pluggable-slot LocatedIn card, MANY2ONE)

    • A pluggable slot is located in a card.(4)

  • TO chassis (PARENT of pluggable-slot, pluggable-slot LocatedIn chassis, MANY2ONE)

    • A pluggable-slot is located in a chassis.(4)

  • FROM pluggable (CHILD of pluggable-slot, pluggable LocatedIn pluggable-slot, ONE2ONE)

    • A pluggable is located in a pluggable-slot.(1)

  • (1) IF this PLUGGABLE-SLOT node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this PLUGGABLE-SLOT is DELETED also
slot-name: string

The name of the pluggable-slot. (unique relative to the chassis or card).

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

pluggables: object[]
pluggable
relationship-list: object
relationship

pluggable-slots: object

pluggable-slot: object[]
pluggable-slot

pluggables: object

pluggable: object[]
pluggable

pnf: object

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.

  • TO autonomous-system( pnf LocatedIn autonomous-system, MANY2ONE)

    • pnf is located in the autonomous-system.

  • TO cloud-region( pnf LocatedIn cloud-region, MANY2ONE)

    • A pnf is located in (aka supports) a cloud-region.

  • TO cloud-region( pnf Uses cloud-region, MANY2MANY)

    • used for CSP pnf to cloud-region.

  • TO complex( pnf LocatedIn complex, MANY2ONE)
  • TO endpoint( pnf Uses endpoint, MANY2MANY)
  • TO ext-aai-network( pnf BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • TO hw-component( pnf MemberOf hw-component, MANY2ONE)

    • The hw-component associated to a pnf

  • TO instance-group( pnf MemberOf instance-group, MANY2MANY)
  • TO instance-group( pnf Primary instance-group, MANY2MANY)
  • TO instance-group( pnf Secondary instance-group, MANY2MANY)
  • TO network-resource( pnf LinksTo network-resource, MANY2MANY)

    • For CCVPN Usecase(4)

  • TO owning-entity( pnf BelongsTo owning-entity, MANY2ONE)
  • TO policy( pnf Uses policy, MANY2MANY)

    • A pnf uses policies

  • TO project( pnf PartOf project, MANY2ONE)

    • The pnf is part of a project (ex, VPMO that ordered the equipment).

  • TO sw-component( pnf MemberOf sw-component, MANY2ONE)

    • The sw-component associated to a pnf

  • TO zone( pnf LocatedIn zone, MANY2ONE)
  • FROM activity (CHILD of pnf, activity AppliesTo pnf, MANY2MANY)

    • The activity applies to a pnf.(1)

  • FROM bgp-group (CHILD of pnf, bgp-group BelongsTo pnf, MANY2ONE)

    • A bgp-group belongs to a pnf.(1)

  • FROM bgp-neighbor (CHILD of pnf, bgp-neighbor BelongsTo pnf, MANY2ONE)

    • A bgp-neighbor belongs to a pnf.(1)

  • FROM chassis( chassis PartOf pnf, MANY2ONE)

    • A chassis is part of a pnf.

  • FROM configuration( configuration AppliesTo pnf, MANY2MANY)
  • FROM contact( contact Supports pnf, ONE2MANY)

    • The contact supports a pnf.

  • FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
  • FROM generic-vnf( generic-vnf HostedOn pnf, MANY2MANY)
  • FROM l-interface (CHILD of pnf, l-interface BelongsTo pnf, MANY2ONE)

    • A logical interface associated with a pnf.(1)

  • FROM lag-interface (CHILD of pnf, lag-interface BindsTo pnf, MANY2ONE)(1)
  • FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
  • FROM mapping( mapping MemberOf pnf, ONE2MANY)

    • The mapping associated to a pnf

  • FROM metadatum( metadatum AppliesTo pnf, MANY2MANY)

    • AAI-2154 For BBS Usecase

  • FROM object-group( object-group AppliesTo pnf, MANY2MANY)
  • FROM p-interface (CHILD of pnf, p-interface BindsTo pnf, MANY2ONE)(1)
  • FROM profile( profile supports pnf, MANY2MANY)
  • FROM profile( profile AppliesTo pnf, MANY2MANY)

    • A profile (set of characteristics) applies to the pnf.

  • FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
  • FROM software-version (CHILD of pnf, software-version BelongsTo pnf, MANY2ONE)
  • FROM tunnel-termination-point( tunnel-termination-point BindsTo pnf, MANY2MANY)

    • For CCVPN Usecase(1)

  • FROM vrf (CHILD of pnf, vrf BelongsTo pnf, MANY2ONE)

    • A vrf belongs to a pnf.(1)

  • (1) IF this PNF node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this PNF is DELETED also
  • PNF cannot be deleted if related to SOFTWARE-VERSION
pnf-name: string

unique name of Physical Network Function.

pnf-name2: string

name of Physical Network Function.

selflink: string

URL to endpoint where AAI can get more details.

pnf-name2-source: string

source of name2

pnf-id: string

id of pnf

nf-naming-code: string

Naming code for network function

network-operating-system: string

Network operating system used on the device.

nf-function: string

The function performed by the pnf.

equip-type: string

Equipment type. Source of truth should define valid values.

equip-vendor: string

Equipment vendor. Source of truth should define valid values.

equip-model: string

Equipment model. Source of truth should define valid values.

management-option: string

identifier of managed customer

orchestration-status: string

Orchestration status of this pnf

ipaddress-v4-oam: string

ipv4-oam-address with new naming convention for IP addresses

sw-version: string

sw-version is the version of SW for the hosted application on the PNF.

in-maint: boolean

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.

frame-id: string

ID of the physical frame (relay rack) where pnf is installed.

serial-number: string

Serial number of the device

ipaddress-v4-loopback-0: string

IPV4 Loopback 0 address

ipaddress-v6-loopback-0: string

IPV6 Loopback 0 address

ipaddress-v4-aim: string

IPV4 AIM address

ipaddress-v6-aim: string

IPV6 AIM address

ipaddress-v6-oam: string

IPV6 OAM address

inv-status: string

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

spare-equipment-indicator: boolean

Flag for identifying spare equipment

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

prov-status: string

Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]

nf-role: string

Nf Role is the role performed by this instance in the network.

admin-status: string

admin Status of this PNF

operational-status: string

Store the operational-status for this object.

model-customization-id: string

Store the model-customization-id for this object.

model-invariant-id: string

The ASDC model id for this resource model.

model-version-id: string

The ASDC model version for this resource model.

ops-note: string

Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.

config-validation-request-id: string

Contains the value of the request id to the most recent configuration file/validation report for this PNF.

config-validation-status: string

Status of latest configuration attempt represented by the config-url.

nf-type: string

Subtype used to categorize this pnf

common-base-indicator: string

Indicates the PNF/R-Leaf was built with the VNF agnostic common base

equipment-clli: string

11-character equipment CLLI.

pnf-ipv4-address: string

This is the IP address (IPv4) for the PNF itself. This is the IPv4 address that the PNF iself can be accessed at.

pnf-ipv6-address: string

This is the IP address (IPv6) for the PNF itself. This is the IPv6 address that the PNF iself can be accessed at.

phone-number: string

Identifies the POTS phone number used to connect to a pnf out-of-band via dial-up.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

software-versions: object[]
software-version
relationship-list: object
relationship
p-interfaces: object[]
p-interface
l-interfaces: object[]
l-interface
lag-interfaces: object[]
lag-interface
activities: object[]
activity
vrfs: object[]
vrf
bgp-groups: object[]
bgp-group
bgp-neighbors: object[]
bgp-neighbor

pnfs: object

Collection of Physical Network Functions.

pnf: object[]
pnf

policies: object

policy: object[]
policy

policy: object

Definition of policy

  • TO address-family( policy AppliesTo address-family, MANY2MANY)

    • A policy applies to an address family.

  • TO bgp-group( policy AppliesTo bgp-group, MANY2MANY)

    • A policy applies to a bgp-group.

  • TO bgp-neighbor( policy AppliesTo bgp-neighbor, MANY2MANY)

    • A policy applies to a bgp-neighbor.

  • TO instance-group( policy AppliesTo instance-group, MANY2ONE)

    • The policy associated to an instance-group

  • TO l-interface( policy AppliesTo l-interface, MANY2MANY)

    • The policy applies to an l-interface.

  • TO l3-network( policy AppliesTo l3-network, MANY2MANY)

    • A policy applies to l3-networks.

  • TO lag-interface( policy AppliesTo lag-interface, MANY2MANY)

    • used to support NCX-Hub

  • TO object-group( policy Uses object-group, MANY2MANY)
  • TO rule (PARENT of policy, policy Implements rule, ONE2MANY)(2)
  • TO vlan-tag( policy AppliesTo vlan-tag, MANY2MANY)

    • 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.

  • TO vpn-binding( policy Uses vpn-binding, ONE2MANY)

    • A policy uses vpn-bindings

  • TO vrf( policy AppliesTo vrf, MANY2MANY)
  • FROM cloud-region( cloud-region Implements policy, MANY2MANY)

    • a cloud-region implements policies

  • FROM configuration( configuration Uses policy, MANY2MANY)

    • A configuration uses a policy

  • FROM ip-address-list (CHILD of policy, ip-address-list BelongsTo policy, MANY2ONE)

    • An ip-address-list BelongsTo a policy.(1)

  • FROM mapping( mapping MemberOf policy, ONE2MANY)

    • The mapping associated to a policy

  • FROM platform( platform Uses policy, ONE2MANY)

    • Used by Auditing applications to identify appropriate audit models based on the platform associated with the given object

  • FROM pnf( pnf Uses policy, MANY2MANY)

    • A pnf uses policies

  • FROM policy-map-member( policy-map-member MemberOf policy, MANY2ONE)

    • Member of policy map

  • FROM profile( profile AppliesTo policy, MANY2MANY)

    • A profile (set of characteristics) applies to the policy.

  • FROM pserver( pserver Implements policy, MANY2MANY)
  • FROM relationship-rule( relationship-rule AppliesTo policy, MANY2MANY)

    • Details relationships policy requires.

  • FROM selector-list (CHILD of policy, selector-list BelongsTo policy, MANY2ONE)(1)

  • (1) IF this POLICY node is deleted, this FROM node is DELETED also
  • (2) IF this POLICY node is deleted, this TO node is DELETED also
  • POLICY cannot be deleted if related to ADDRESS-FAMILY,BGP-GROUP,BGP-NEIGHBOR,VLAN-TAG,POLICY-MAP-MEMBER
policy-id: string

Unique Policy UUID.

policy-name: string

Policy Name

policy-type: string

Policy Type

policy-role: string

Policy role

policy-function: string

policy function

do-not-track: boolean

Do not track

pre-dnat: boolean

Pre destination NAT

apply-on-forward: boolean

apply on forward

selector: string

Host and Interface Type Selector

order: integer

Order

version: string

Version

status: string

Status

remote-asn: integer

Remote ASN

namespace: string

Namespace filter to apply the policy

policy-description: string

Description of the policy

policy-variables: string

Set of rule variables

policy-variable-name: string

Policy Variable Name

direction: string

policy direction set as ingress or egress

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

rules: object[]
rule
ip-address-list: object[]
ip-address-list
selector-list: object[]
selector-list
relationship-list: object
relationship

policy-key-term: object

Policy key term related to a policy map member

  • TO parameter-list( policy-key-term Uses parameter-list, MANY2MANY)

    • policy-key-term to parameter-list

  • FROM policy-map-member( policy-map-member Uses policy-key-term, ONE2MANY)

    • Policy key term related to policy map member

  • POLICY-KEY-TERM cannot be deleted if related to PARAMETER-LIST
policy-key-term-id: string

unique ID

sequence-number: string

numeric indicating the sequence of the key term

key-word: string

key word, for example police, set, priority level, shape

key-word-qualifier: string

qualifier, for example rate, traffic class, avg percent

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

policy-key-terms: object

Collection of policy key terms.

policy-key-term: object[]
policy-key-term

policy-map-member: object

Member of a policy map used for QOS

  • TO class-map( policy-map-member Uses class-map, MANY2MANY)

    • Class-map related to policy-map-member

  • TO policy-key-term( policy-map-member Uses policy-key-term, ONE2MANY)

    • Policy key term related to policy map member

  • TO policy( policy-map-member MemberOf policy, MANY2ONE)

    • Member of policy map

  • POLICY-MAP-MEMBER cannot be deleted if related to CLASS-MAP,POLICY-KEY-TERM
policy-map-member-id: string

unique ID

sequence-number: string

indicate the sequence of the member

member-type: string

valid values are QOS-CLASS or END-POLICY-MAP

qos-class-name: string

used to map to the class-map

class-type: string

valid value is traffic

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

policy-map-members: object

Collection of policy map members.

policy-map-member: object[]
policy-map-member

port: object

Definition of port

  • TO cable( port LinksTo cable, MANY2ONE)

    • A channel-interface terminates a channel-link.

  • TO card (PARENT of port, port LocatedIn card, MANY2ONE)

    • A port is located in a card.(4)

  • TO chassis (PARENT of port, port LocatedIn chassis, MANY2ONE)

    • A port is LocatedIn a chassis.(4)

  • TO p-interface( port ComposedOf p-interface, MANY2MANY)

    • A port is composed of one or more p-interfaces.(2)

  • TO pluggable (PARENT of port, port LocatedIn pluggable, MANY2ONE)

    • A port is located in a pluggable.(4)

  • TO port( port LinksTo port, ONE2ONE)

    • A port LinksTo another port.

  • FROM logical-link( logical-link Uses port, ONE2MANY)

    • The port associated with a logical-link(3)

  • FROM port( port LinksTo port, ONE2ONE)

    • A port LinksTo another port.

  • (2) IF this PORT node is deleted, this TO node is DELETED also
  • (3) IF this FROM node is deleted, this PORT is DELETED also
  • (4) IF this TO node is deleted, this PORT is DELETED also
  • PORT cannot be deleted if related to CABLE
port-name: string

A unique name for the port relative to the containing hardware.

port-type: string

The type of port.

port-role: string

The role of the port.

speed-value: string

The numeric value for the speed of the port.

speed-units: string

The units for the speed of the port.

xcvr-type: string

Type of transceiver that creates this port.

equip-identifier: string

clei-code or other similar identifier

part-number: string

part number

port-start: string

Port range start

port-end: string

Port range end

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

port-group: object

Used to capture the network interfaces of this VCE

  • TO vce (PARENT of port-group, port-group BelongsTo vce, MANY2ONE)(4)
  • FROM cvlan-tag (CHILD of port-group, cvlan-tag BelongsTo port-group, MANY2ONE)(1)

  • (1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this PORT-GROUP is DELETED also
interface-id: string

Unique ID of the interface

neutron-network-id: string

Neutron network id of this Interface

neutron-network-name: string

Neutron network name of this Interface

interface-role: string

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

port-group-id: string

Unique ID for port group in vmware

port-group-name: string

Likely to duplicate value of neutron network name

switch-name: string

DVS or standard switch name (should be non-null for port groups associated with DVS)

orchestration-status: string

Orchestration status of this VNF, mastered by MSO

heat-stack-id: string

Heat stack id corresponding to this instance, managed by MSO

mso-catalog-key: string

Corresponds to the SDN-C catalog id used to configure this VCE

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

cvlan-tags: object[]
cvlan-tag-entry
relationship-list: object
relationship

port-groups: object

port-group: object[]
port-group

port-list: object

Port List Range

  • TO endpoint (PARENT of port-list, port-list BelongsTo endpoint, MANY2ONE)(4)
  • TO object-group (PARENT of port-list, port-list BelongsTo object-group, MANY2ONE)(4)
  • TO rule (PARENT of port-list, port-list BelongsTo rule, MANY2ONE)(4)
  • FROM ip-address-list( ip-address-list BelongsTo port-list, MANY2MANY)

  • (4) IF this TO node is deleted, this PORT-LIST is DELETED also
port: string

Port number

assignment: string

Name or assignment for the port

type: string

Type or usage of the port

operator: string

Operator to apply to the port (greater than, less than, etc).

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

ports: object

port: object[]
port

profile: object

describes an profiles

  • TO card( profile AppliesTo card, MANY2MANY)

    • The profile (set of characteristics) applies to the card.

  • TO chassis( profile AppliesTo chassis, MANY2MANY)

    • The profile (set of characteristics) applies to the chassis.

  • TO cloud-region( profile AppliesTo cloud-region, MANY2MANY)
  • TO endpoint( profile AppliesTo endpoint, MANY2MANY)

    • A profile (set of characteristics) applies to the endpoint.

  • TO hardware-catalog-item( profile AppliesTo hardware-catalog-item, MANY2MANY)

    • A set of characteristics of the hardware-catalog-item.

  • TO instance-group( profile AppliesTo instance-group, MANY2MANY)

    • A profile (set of characteristics) applies to the instance-group (as a vrrp group).

  • TO l-interface( profile AppliesTo l-interface, MANY2MANY)

    • A profile (set of characteristics) applies to the l-interface.

  • TO l3-network( profile AppliesTo l3-network, MANY2MANY)

    • A profile (set of characteristics) applies to the l3-network.

  • TO lag-interface( profile AppliesTo lag-interface, MANY2MANY)

    • A profile (set of characteristics) applies to the lag-interface.

  • TO logical-link( profile AppliesTo logical-link, MANY2MANY)

    • A profile (set of characteristics) applies to the logical-link.

  • TO object-group( profile AppliesTo object-group, MANY2MANY)

    • The profile (set of characteristics) classifies the object-group.

  • TO p-interface( profile AppliesTo p-interface, MANY2MANY)

    • A profile (set of characteristics) applies to the p-interface.

  • TO pdu( profile AppliesTo pdu, MANY2MANY)

    • The profile (set of characteristics) applies to the pdu.

  • TO physical-link( profile AppliesTo physical-link, MANY2MANY)

    • A profile (set of characteristics) applies to the physical-link.

  • TO pluggable( profile AppliesTo pluggable, MANY2MANY)

    • The profile (set of characteristics) applies to the pluggable.

  • TO pnf( profile supports pnf, MANY2MANY)
  • TO pnf( profile AppliesTo pnf, MANY2MANY)

    • A profile (set of characteristics) applies to the pnf.

  • TO policy( profile AppliesTo policy, MANY2MANY)

    • A profile (set of characteristics) applies to the policy.

  • TO pserver( profile supports pserver, MANY2MANY)
  • TO pserver( profile AppliesTo pserver, MANY2MANY)

    • A profile (set of characteristics) applies to the pserver.

  • TO rack( profile AppliesTo rack, MANY2MANY)

    • The profile (set of characteristics) applies to the rack.

  • TO subnet( profile AppliesTo subnet, MANY2MANY)

    • A profile (set of characteristics) applies to the subnet.

  • TO vlan-range( profile AppliesTo vlan-range, MANY2MANY)

    • A profile (set of characteristics) applies to the vlan-range.

  • TO vlan-tag( profile AppliesTo vlan-tag, MANY2MANY)

    • A profile (set of characteristics) applies to the vlan-tag.

  • TO vpn-binding( profile AppliesTo vpn-binding, MANY2MANY)

    • A profile (set of characteristics) applies to the vpn-binding.

  • TO vrf( profile AppliesTo vrf, MANY2MANY)

    • A profile (set of characteristics) applies to the vrf.

  • TO vserver( profile supports vserver, MANY2MANY)
  • FROM hw-component( hw-component AppliesTo profile, MANY2MANY)

    • The profile associated to a hw-component

  • FROM metadatum (CHILD of profile, metadatum BelongsTo profile, MANY2ONE)(1)
  • FROM platform( platform Uses profile, ONE2MANY)

    • Used by Auditing applications to identify appropriate audit models based on the platform associated with the given object

  • FROM relationship-rule( relationship-rule AppliesTo profile, MANY2MANY)

    • Details relationships profile requires.

  • FROM sw-component( sw-component AppliesTo profile, MANY2MANY)

    • The profile associated to a sw-component

  • (1) IF this PROFILE node is deleted, this FROM node is DELETED also
  • PROFILE cannot be deleted if related to CARD,CHASSIS,ENDPOINT,HARDWARE-CATALOG-ITEM,INSTANCE-GROUP,L-INTERFACE,L3-NETWORK,LAG-INTERFACE,LOGICAL-LINK,OBJECT-GROUP,P-INTERFACE,PDU,PHYSICAL-LINK,PLUGGABLE,PNF,POLICY,PSERVER,RACK,SUBNET,VLAN-RANGE,VLAN-TAG,VPN-BINDING,VRF
profile-name: string

Name of the profile

profile-type: string

Type of profile (ex,network-power-profile)

profile-characteristics: string

Set of characteristics of the profile.

profile-subtype: string

Descriptive subtype.

profile-role: string

used to categorize this object in conjunction with profile-type and profile-function.

profile-function: string

used to categorize this object in conjunction with profile-type and profile-role. The most specific category

profile-selflink: string

URL to endpoint where AAI can get more details

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship
metadata: object[]
metadatum

profiles: object

Collection of profiles

profile: object[]
profile

project: object

describes the project

  • TO service-instance( project Uses service-instance, ONE2MANY)
  • FROM cloud-region( cloud-region PartOf project, MANY2ONE)

    • The cloud-region is part of a project (ex, project that built out the cloud region).

  • FROM pnf( pnf PartOf project, MANY2ONE)

    • The pnf is part of a project (ex, VPMO that ordered the equipment).

  • FROM pserver( pserver PartOf project, MANY2ONE)

    • The pserver is part of a project (ex, VPMO that ordered the equipment).

project-name: string

Name of the project deploying a service

project-type: string

Type of project (ex, VPMO)

project-state: string

Current state of the project.

description: string

Description of the project.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

projects: object

Collection of projects

project: object[]
project

properties: object

Property holder for query properties or instance properties

property-name: string
property-value: string

property-constraint: object

TBD

  • TO named-query-element (PARENT of property-constraint, property-constraint BelongsTo named-query-element, MANY2ONE)(4)

  • (4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
property-constraint-uuid: string
constraint-type: string
property-name: string
property-value: string
resource-version: string

property-constraints: object

property-constraint: object[]
property-constraint

pserver: object

Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.

  • TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
  • TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
  • TO complex( pserver LocatedIn complex, MANY2ONE)
  • TO endpoint( pserver Uses endpoint, MANY2MANY)
  • TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
  • TO hw-component( pserver MemberOf hw-component, MANY2ONE)

    • The hw-component associated to a pserver

  • TO policy( pserver Implements policy, MANY2MANY)
  • TO project( pserver PartOf project, MANY2ONE)

    • The pserver is part of a project (ex, VPMO that ordered the equipment).

  • TO sw-component( pserver MemberOf sw-component, MANY2ONE)

    • The sw-component associated to a pserver

  • TO zone( pserver LocatedIn zone, MANY2ONE)
  • FROM activity (CHILD of pserver, activity AppliesTo pserver, MANY2MANY)

    • The activity applies to a pserver.(1)

  • FROM chassis( chassis PartOf pserver, MANY2MANY)

    • A chassis is part of a pserver.

  • FROM contact( contact Supports pserver, ONE2MANY)

    • The contact supports a pserver.

  • FROM flavor( flavor CanBeInstantiatedIn pserver, MANY2MANY)

    • HPA Capacity getting the compute nodes from given flavor

  • FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
  • FROM host-aggregate( host-aggregate BelongsTo pserver, MANY2ONE)
  • FROM hpa-capacity (CHILD of pserver, hpa-capacity BelongsTo pserver, MANY2ONE)

    • HPA Capacity KV for given compute node(1)

  • FROM l-interface (CHILD of pserver, l-interface BelongsTo pserver, MANY2ONE)

    • A logical interface associated with a pserver.(1)

  • FROM lag-interface (CHILD of pserver, lag-interface BindsTo pserver, MANY2ONE)(1)
  • FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
  • FROM nos-server( nos-server HostedOn pserver, ONE2ONE)
  • FROM p-interface (CHILD of pserver, p-interface BindsTo pserver, MANY2ONE)(1)
  • FROM profile( profile supports pserver, MANY2MANY)
  • FROM profile( profile AppliesTo pserver, MANY2MANY)

    • A profile (set of characteristics) applies to the pserver.

  • FROM vserver( vserver HostedOn pserver, MANY2ONE)

  • (1) IF this PSERVER node is deleted, this FROM node is DELETED also
  • PSERVER cannot be deleted if related to ENDPOINT,GROUP-ASSIGNMENT,GENERIC-VNF,LOGICAL-LINK,NOS-SERVER,VSERVER
hostname: string

Value from executing hostname on the compute node.

ptnii-equip-name: string

PTNII name

number-of-cpus: integer

Number of cpus

disk-in-gigabytes: integer

Disk size, in GBs

ram-in-megabytes: integer

RAM size, in MBs

equip-type: string

Equipment type. Source of truth should define valid values.

equip-vendor: string

Equipment vendor. Source of truth should define valid values.

equip-model: string

Equipment model. Source of truth should define valid values.

fqdn: string

Fully-qualified domain name

pserver-selflink: string

URL to endpoint where AAI can get more details

ipv4-oam-address: string

Used to configure device, also used for troubleshooting and is IP used for traps generated by device.

serial-number: string

Serial number, may be queried

ipaddress-v4-loopback-0: string

IPV4 Loopback 0 address

ipaddress-v6-loopback-0: string

IPV6 Loopback 0 address

ipaddress-v4-aim: string

IPV4 AIM address

ipaddress-v6-aim: string

IPV6 AIM address

ipaddress-v6-oam: string

IPV6 OAM address

inv-status: string

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

pserver-id: string

ID of Pserver

internet-topology: string

internet topology of Pserver

in-maint: boolean

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.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

pserver-name2: string

alternative pserver name

purpose: string

purpose of pserver

prov-status: string

Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]

management-option: string

Indicates who owns and or manages the device.

host-profile: string

The host profile that defines the configuration of the pserver.

role: string

The role performed by the pserver.

function: string

The function performed by the pserver.

ops-note: string

Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

operational-status: string

Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.

relationship-list: object
relationship
p-interfaces: object[]
p-interface
l-interfaces: object[]
l-interface
lag-interfaces: object[]
lag-interface
activities: object[]
activity
hpa-capacity: object[]
hpa-capacity

pservers: object

Collection of compute hosts.

pserver: object[]
pserver

query-parameters: object

QueryParameters for performing a named-query or model query

named-query: object
named-query
overloaded-model: object
overloaded-model

rack: object

Definition of rack

  • TO complex (PARENT of rack, rack LocatedIn complex, MANY2ONE)

    • A rack is located in a complex (aka building).(4)

  • TO hardware-catalog-item( rack IsA hardware-catalog-item, MANY2ONE)

    • The rack is this item from the hardware-catalog.

  • TO instance-group( rack MemberOf instance-group, MANY2ONE)

    • The rack is a member of the instance-group (rack-group or pod).

  • FROM chassis( chassis LocatedIn rack, MANY2ONE)

    • A chassis is LocatedIn a rack.

  • FROM pdu (CHILD of rack, pdu LocatedIn rack, MANY2ONE)

    • A pdu is located in a building (aka complex).(1)

  • FROM profile( profile AppliesTo rack, MANY2MANY)

    • The profile (set of characteristics) applies to the rack.

  • FROM rack-unit (CHILD of rack, rack-unit LocatedIn rack, MANY2ONE)

    • A rack-unit is located in a rack.(1)

  • (1) IF this RACK node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this RACK is DELETED also
  • RACK cannot be deleted if related to CHASSIS
rack-name: string

A unique name for the rack (within the location).

rack-type: string

The type of rack.

rack-location: string

The location of the rack within the building.

rack-position: string

The position of the rack (ex-floor-mounted).

rack-power-diversity: boolean
data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship
rack-units: object[]
rack-unit
pdus: object[]
pdu

rack-unit: object

Definition of rack-unit

  • TO rack (PARENT of rack-unit, rack-unit LocatedIn rack, MANY2ONE)

    • A rack-unit is located in a rack.(4)

  • FROM chassis( chassis Uses rack-unit, ONE2MANY)

    • A chassis uses space in a rack (aka one or more rack-units).

  • FROM pdu( pdu Uses rack-unit, ONE2MANY)

    • A pdu uses space in a rack (aka one or more rack-units).

  • (4) IF this TO node is deleted, this RACK-UNIT is DELETED also
  • RACK-UNIT cannot be deleted if related to CHASSIS,PDU
rack-unit-name: string

A unique name for the rack-unit (within the rack).

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

rack-units: object

rack-unit: object[]
rack-unit

racks: object

rack: object[]
rack

relationship: object

dictionary of relationship

relationship: object[]
relationship-dict

relationship-component: object

describes an relationship component

  • TO relationship-rule (PARENT of relationship-component, relationship-component BelongsTo relationship-rule, MANY2ONE)

    • Defines the traversal needed to reach the node of relationship-rule(4)

  • (4) IF this TO node is deleted, this RELATIONSHIP-COMPONENT is DELETED also
rule-node: string

NARAD object

rule-property: string

Object property

rule-value: string

Property value

component-order: integer

Order in traversal

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

relationship-components: object

Collection of relationship components

relationship-component: object[]
relationship-component

relationship-data: object

relationship-key: string

A keyword provided by A&AI to indicate an attribute.

relationship-value: string

Value of the attribute.

relationship-dict: object

related-to: string

A keyword provided by A&AI to indicate type of node.

relationship-label: string

The edge label for this relationship.

related-link: string

URL to the object in A&AI.

relationship-data: object[]
relationship-data

relationship-list: object

relationship: object
relationship

relationship-properties: object

data-owner: string

Key part of a key/value pair

data-source: string

Key part of a key/value pair

data-source-version: string

Key part of a key/value pair

relationship-rule: object

describes an relationship rule

  • TO endpoint( relationship-rule AppliesTo endpoint, MANY2MANY)

    • Details relationships endpoint requires

  • TO object-group( relationship-rule AppliesTo object-group, MANY2MANY)

    • Details relationships object-group requires

  • TO policy( relationship-rule AppliesTo policy, MANY2MANY)

    • Details relationships policy requires.

  • TO profile( relationship-rule AppliesTo profile, MANY2MANY)

    • Details relationships profile requires.

  • FROM relationship-component (CHILD of relationship-rule, relationship-component BelongsTo relationship-rule, MANY2ONE)

    • Defines the traversal needed to reach the node of relationship-rule(1)

  • (1) IF this RELATIONSHIP-RULE node is deleted, this FROM node is DELETED also
  • RELATIONSHIP-RULE cannot be deleted if related to ENDPOINT
rule-id: string

UUID.

context: string

Example global,site

rule-traversals: integer

Number of traversals

applies-to: string

Node the related object applies to

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-components: object[]
relationship-component
relationship-list: object
relationship

relationship-rules: object

Collection of relationship rules

relationship-rule: object[]
relationship-rule

reserved-prop-names: object

Internal map to define some reserved properties of a vertex

last-mod-source-of-truth: string
aai-node-type: string
aai-created-ts: integer
aai-unique-key: string
aai-last-mod-ts: integer
source-of-truth: string
aai-uri: string

response-list: object

Response container for the results of a named-query or model query

inventory-response-items: object
inventory-response-items

result-data: object

resource-type: string

The specific type of node in the A&AI graph

resource-link: string

The URL to the specific resource

route-table-reference: object

Openstack route table reference.

  • FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
route-table-reference-id: string

Route Table Reference id, UUID assigned to this instance.

route-table-reference-fqdn: string

FQDN entry in the route table.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Concurrency value

relationship-list: object
relationship

route-table-references: object

Collection of openstack route table references

route-table-reference: object[]
route-table-reference

route-target: object

Route target information

  • TO vpn-binding (PARENT of route-target, route-target BelongsTo vpn-binding, MANY2ONE)(4)
  • TO vrf (PARENT of route-target, route-target BelongsTo vrf, MANY2ONE)(4)

  • (4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
global-route-target: string

Number used to identify an RT, globally unique in the network

route-target-role: string

Role assigned to this route target

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

route-targets: object

Collection of route target information

route-target: object[]
route-target

routing-instance: object

Collection of routing tables, interfaces, and routing protocol parameters.

  • TO site-pair-set (PARENT of routing-instance, routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
  • FROM site-pair (CHILD of routing-instance, site-pair BelongsTo routing-instance, MANY2ONE)(1)

  • (1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
routing-instance-id: string

Unique id of routing instance

rpm-owner: string

rpm owner

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

site-pairs: object[]
site-pair
relationship-list: object
relationship

routing-instances: object

set of probes related to generic-vnf routing instance

routing-instance: object[]
routing-instance

rule: object

describes an rules

  • TO next-hop( rule Uses next-hop, MANY2MANY)

    • The rule that is used by the next-hop. For CG-NAT these are the ACL policies.

  • TO object-group( rule Uses object-group, MANY2MANY)
  • TO object-group( rule AppliesTo object-group, MANY2MANY)
  • TO object-group( rule Source object-group, MANY2MANY)
  • TO object-group( rule Destination object-group, MANY2MANY)
  • FROM ip-address-list (CHILD of rule, ip-address-list BelongsTo rule, MANY2ONE)(1)
  • FROM metadatum (CHILD of rule, metadatum BelongsTo rule, MANY2ONE)(1)
  • FROM policy (PARENT of rule, policy Implements rule, ONE2MANY)(3)
  • FROM port-list (CHILD of rule, port-list BelongsTo rule, MANY2ONE)(1)
  • FROM selector-list (CHILD of rule, selector-list BelongsTo rule, MANY2ONE)(1)

  • (1) IF this RULE node is deleted, this FROM node is DELETED also
  • (3) IF this FROM node is deleted, this RULE is DELETED also
rule-id: string

UUID.

direction: string

ingress or egress

protocol: string

Positive protocol match. tcp, udp, icmpv6, sctp, udplite, integer 1-255.

not-protocol: string

Negative protocol match. tcp, udp, icmpv6, sctp, udplite, integer 1-255.

action: string

Action to perform when matching this rule.

icmp: string
not-icmp: string
sequence: integer

Sequence number of the rule.

threshold: integer

Threshold

status: string

status

version: string

Version

count-variable: string

Named variable used for counting transactions.

log: boolean

Boolean to indicate whether or not logging is required.

description: string

Description.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

ip-address-list: object[]
ip-address-list
port-list: object[]
port-list
selector-list: object[]
selector-list
metadata: object[]
metadatum
relationship-list: object
relationship

rules: object

Collection of rules

rule: object[]
rule

sdn-zone-response: object

oam-networks: object
oam-networks
az-and-dvs-switches: object[]
az-and-dvs-switches

sdwan-vpn: object

Instance of an sdwan-vpn

  • TO ext-aai-network( sdwan-vpn BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • TO generic-vnf( sdwan-vpn PartOf generic-vnf, MANY2MANY)

    • For CCVPN Usecase

  • TO service-instance( sdwan-vpn PartOf service-instance, ONE2MANY)

    • For CCVPN Usecase

  • TO tenant( sdwan-vpn PartOf tenant, ONE2MANY)

    • For CCVPN Usecase

  • TO vpn-binding( sdwan-vpn PartOf vpn-binding, ONE2MANY)

    • For CCVPN Usecase

sdwan-vpn-id: string

Uniquely identifies this sdwan-vpn by id

sdwan-vpn-name: string

Store the name of this sdwan-vpn.

vxlan-id: string

Store the vxlan-id of this sdwan-vpn.

topology: string

Store the topology of this sdwan-vpn.

tenant-id: string

Store the tenant-id of this sdwan-vpn.

vpn-id: string

Store the vpn-id of this sdwan-vpn.

selflink: string

Store the link to get more information for this object.

operational-status: string

Store the operational-status for this object.

model-customization-id: string

Store the model-customization-id for this object.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

sdwan-vpns: object

Collection of sdwan-vpns

sdwan-vpn: object[]
sdwan-vpn

search-results: object

result-data: object[]
result-data

secondary-filt: object

SecondaryFilt for performing a named-query or model query

secondary-filter: object

property-name: string
filter-type: string
property-value: string

secondary-filts: object

SecondaryFilts for performing a named-query or model query

secondary-filt: object[]
secondary-filt

segmentation-assignment: object

Openstack segmentation assignment.

  • TO l3-network (PARENT of segmentation-assignment, segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)

  • (4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
segmentation-id: string

Route Table Reference id, UUID assigned to this instance.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Concurrency value

relationship-list: object
relationship

segmentation-assignments: object

Collection of openstack segmentation assignments

segmentation-assignment: object[]
segmentation-assignment

selector-list: object

Selectors list

  • TO endpoint (PARENT of selector-list, selector-list BelongsTo endpoint, MANY2ONE)(4)
  • TO object-group (PARENT of selector-list, selector-list BelongsTo object-group, MANY2ONE)(4)
  • TO policy (PARENT of selector-list, selector-list BelongsTo policy, MANY2ONE)(4)
  • TO rule (PARENT of selector-list, selector-list BelongsTo rule, MANY2ONE)(4)

  • (4) IF this TO node is deleted, this SELECTOR-LIST is DELETED also
selector: string

Selector

assignment: string

Name or assignment for the selector

type: string

Type or usage of the selector

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

service: object

Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.

service-id: string

This gets defined by others to provide a unique ID for the service, we accept what is sent.

service-description: string

Description of the service

service-selflink: string

URL to endpoint where AAI can get more details

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

service-version: string

service version

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

service-capabilities: object

Collection of service capabilities.

service-capability: object[]
service-capability

service-capability: object

Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.

  • FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
  • FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)

  • SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
service-type: string

This gets defined by others to provide a unique ID for the service, we accept what is sent.

vnf-type: string

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.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

service-design-and-creation: object

Namespace for objects managed by ASDC

vnf-images: object[]
vnf-image
services: object[]
service
service-capabilities: object[]
service-capability
models: object[]
model
named-queries: object[]
named-query

service-instance: object

Instance of a service

  • TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
  • TO collection( service-instance ComposedOf collection, ONE2ONE)
  • TO composed-resource( service-instance BelongsTo composed-resource, ONE2ONE)
  • TO configuration( service-instance Uses configuration, ONE2MANY)
  • TO configuration( service-instance ComposedOf configuration, MANY2MANY)
  • TO connector( service-instance Uses connector, MANY2MANY)
  • TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
  • TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
  • TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
  • TO instance-group( service-instance Uses instance-group, ONE2MANY)

    • MSO creates this edge on VNF Group Service creation

  • TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
  • TO l3-network( service-instance ComposedOf l3-network, MANY2MANY)
  • TO logical-link( service-instance Uses logical-link, MANY2MANY)(2)
  • TO network-route( service-instance ComposedOf network-route, MANY2MANY)(2)
  • TO owning-entity( service-instance BelongsTo owning-entity, MANY2ONE)
  • TO owning-entity( service-instance Uses owning-entity, MANY2ONE)

    • service-instance Uses an owning-entity

  • TO owning-entity( service-instance Uses owning-entity, MANY2ONE)

    • service-instance Uses an owning-entity

  • TO p-interface( service-instance ComposedOf p-interface, ONE2MANY)

    • For MDONS Use case

  • TO pnf( service-instance ComposedOf pnf, ONE2MANY)
  • TO service-instance( service-instance ComposedOf service-instance, MANY2MANY)
  • TO service-subscription (PARENT of service-instance, service-instance BelongsTo service-subscription, MANY2ONE)

    • service-instance BelongsTo service-subscription(4)

  • TO vce( service-instance ComposedOf vce, ONE2MANY)
  • TO vlan( service-instance ComposedOf vlan, ONE2MANY)
  • TO vrf( service-instance ComposedOf vrf, MANY2MANY)

    • This edge relates a vrf that is configured on a pnf to the service-instances that the vrf supports.

  • TO zone( service-instance LocatedIn zone, MANY2ONE)
  • FROM allotted-resource (CHILD of service-instance, allotted-resource BelongsTo service-instance, MANY2ONE)(1)
  • FROM cloud-region( cloud-region Uses service-instance, MANY2MANY)
  • FROM communication-service-profile (CHILD of service-instance, communication-service-profile BelongsTo service-instance, ONE2ONE)
  • FROM composed-resource (CHILD of service-instance, composed-resource ComposedOf service-instance, MANY2ONE)(1)
  • FROM connectivity( connectivity PartOf service-instance, MANY2MANY)

    • For CCVPN Usecase

  • FROM device( device PartOf service-instance, ONE2MANY)

    • For CCVPN Usecase

  • FROM forwarding-path( forwarding-path AppliesTo service-instance, MANY2ONE)(1)
  • FROM lan-port-config( lan-port-config PartOf service-instance, ONE2MANY)

    • For CCVPN Usecase

  • FROM metadatum (CHILD of service-instance, metadatum BelongsTo service-instance, MANY2ONE)(1)
  • FROM project( project Uses service-instance, ONE2MANY)
  • FROM sdwan-vpn( sdwan-vpn PartOf service-instance, ONE2MANY)

    • For CCVPN Usecase

  • FROM service-instance( service-instance ComposedOf service-instance, MANY2MANY)
  • FROM service-profile (CHILD of service-instance, service-profile BelongsTo service-instance, ONE2ONE)
  • FROM site-resource( site-resource PartOf service-instance, MANY2MANY)

    • For CCVPN Usecase

  • FROM slice-profile (CHILD of service-instance, slice-profile BelongsTo service-instance, MANY2ONE)
  • FROM sp-partner( sp-partner PartOf service-instance, ONE2MANY)

    • For CCVPN Usecase

  • FROM wan-port-config( wan-port-config PartOf service-instance, MANY2MANY)

    • For CCVPN Usecase

  • FROM zone( zone Uses service-instance, MANY2MANY)

  • (1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
  • (2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
  • (4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
  • SERVICE-INSTANCE cannot be deleted if related to VRF
service-instance-id: string

Uniquely identifies this instance of a service

service-instance-name: string

This field will store a name assigned to the service-instance.

service-type: string

String capturing type of service.

service-role: string

String capturing the service role.

service-rate: string

Rate of the service instance.

service-layer: string

Definition of the service layer.

due-date: string

Due date of the service creation.

end-date: string

End date of the service creation.

environment-context: string

This field will store the environment context assigned to the service-instance.

workload-context: string

This field will store the workload context assigned to the service-instance.

created-at: string

create time of Network Service.

updated-at: string

last update of Network Service.

description: string

short description for service-instance.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

persona-model-version: string

the ASDC model version for this resource or service model.

widget-model-id: string

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

widget-model-version: string

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

bandwidth-total: string

Indicates the total bandwidth to be used for this service.

bandwidth-up-wan1: string

indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.

bandwidth-down-wan1: string

indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.

bandwidth-up-wan2: string

indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.

bandwidth-down-wan2: string

indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.

vhn-portal-url: string

URL customers will use to access the vHN Portal.

service-instance-location-id: string

An identifier that customers assign to the location where this service is being used.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

selflink: string

Path to the controller object.

orchestration-status: string

Orchestration status of this service.

input-parameters: string

String capturing request parameters from SO to pass to Closed Loop.

service-function: string

String capturing function of the service.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

operational-status: string

Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.

relationship-list: object
relationship
metadata: object[]
metadatum
allotted-resources: object[]
allotted-resource
composed-resources: object[]
composed-resource
communication-service-profiles: object[]
communication-service-profile
service-profiles: object[]
service-profile
slice-profiles: object[]
slice-profile

service-instances: object

Collection of service instances

service-instance: object[]
service-instance

service-profile: object

Requirement of E2E Slice service.

  • TO service-instance (PARENT of service-profile, service-profile BelongsTo service-instance, ONE2ONE)
profile-id: string

ID of the profile.

latency: integer

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.

max-number-of-UEs: integer

The maximum number of UEs may simultaneously access the E2E slice service

coverage-area-TA-list: string

A list of TrackingAreas where the NSI can be selected.

ue-mobility-level: string

User mobility level, value can be stationary, nomadic, restricted mobility, fully mobility.

resource-sharing-level: string

Whether the resources to be allocated to the network slice instance may be shared with another network slice instance(s).

activity-factor: integer

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.

jitter: integer

The jitter requirements of network slice.

survival-time: string

An attribute specifies the time that an application consuming a communication service may continue without an anticipated message.

reliability: string

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.

dl-thpt-per-slice: integer

This attribute defines achievable data rate of the network slice in downlink that is available ubiquitously across the coverage area of the slice.

dl-thpt-per-UE: integer

This attribute defines downlink data rate supported by the network slice per UE.

ul-thpt-per-slice: integer

This attribute defines achievable data rate of the network slice in uplink that is available ubiquitously across the coverage area of the slice.

ul-thpt-per-UE: integer

This attribute defines uplink data rate supported by the network slice per UE.

max-pkt-size: integer

This parameter specifies the maximum packet size supported by the network slice.

max-number-of-conns: integer

This parameter defines the maximum number of concurrent sessions supported by the network slice.

term-density: integer

An attribute specifies the overall user density over the coverage area of the network slice.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

service-profiles: object

Collection of E2E slice service profile.

service-profile: object[]
service-profile

service-subscription: object

Object that group service instances.

  • TO customer (PARENT of service-subscription, service-subscription BelongsTo customer, MANY2ONE)

    • service-subscription BelongsTo customer(4)

  • TO tenant( service-subscription Uses tenant, MANY2MANY)
  • FROM service-instance (CHILD of service-subscription, service-instance BelongsTo service-subscription, MANY2ONE)

    • service-instance BelongsTo service-subscription(1)

  • (1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
service-type: string

Value defined by orchestration to identify this service across ONAP.

temp-ub-sub-account-id: string

This property will be deleted from A&AI in the near future. Only stop gap solution.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

service-instances: object[]
service-instance
relationship-list: object
relationship

service-subscriptions: object

Collection of objects that group service instances.

service-subscription: object[]
service-subscription

services: object

Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.

service: object[]
service

site-pair: object

  • TO routing-instance (PARENT of site-pair, site-pair BelongsTo routing-instance, MANY2ONE)(4)
  • FROM class-of-service (CHILD of site-pair, class-of-service BelongsTo site-pair, MANY2ONE)(1)

  • (1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this SITE-PAIR is DELETED also
site-pair-id: string

unique identifier of probe

source-ip: string

Prefix address

destination-ip: string

Prefix address

ip-version: string

ip version, v4, v6

destination-hostname: string

Hostname of the destination equipment to which SLAs are measured against.

destination-equip-type: string

The type of destinatination equipment. Could be Router, UCPE, etc.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

classes-of-service: object[]
class-of-service
relationship-list: object
relationship

site-pair-set: object

Set of instances for probes used to measure service level agreements

  • TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
  • FROM routing-instance (CHILD of site-pair-set, routing-instance BelongsTo site-pair-set, MANY2ONE)(1)

  • (1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
site-pair-set-id: string

Unique id of site pair set.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

routing-instances: object[]
routing-instance
relationship-list: object
relationship

site-pair-sets: object

Collection of sets of instances for probes related to generic-vnf

site-pair-set: object[]
site-pair-set

site-pairs: object

probe within a set

site-pair: object[]
site-pair

site-resource: object

Instance of a site-resource

  • TO allotted-resource( site-resource Uses allotted-resource, MANY2MANY)

    • For CCVPN Usecase

  • TO complex( site-resource Uses complex, MANY2MANY)

    • For CCVPN Usecase

  • TO ext-aai-network( site-resource BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • TO generic-vnf( site-resource PartOf generic-vnf, MANY2MANY)

    • For CCVPN Usecase

  • TO service-instance( site-resource PartOf service-instance, MANY2MANY)

    • For CCVPN Usecase

site-resource-id: string

Uniquely identifies this site-resource by id

site-resource-name: string

Store the name of this site-resource.

description: string

Store the description of this site-resource.

type: string

Store the type of this site-resource.

role: string

Store the role of this site-resource.

generated-site-id: string

Store the generated-site-id of this site-resource.

selflink: string

Store the link to get more information for this object.

operational-status: string

Store the operational-status for this object.

model-customization-id: string

Store the model-customization-id for this object.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

site-resources: object

Collection of site-resources

site-resource: object[]
site-resource

slice-profile: object

Requirement of network slice subnet service.

  • TO service-instance (PARENT of slice-profile, slice-profile BelongsTo service-instance, MANY2ONE)
profile-id: string

ID of the profile.

latency: integer

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.

max-number-of-UEs: integer

The maximum number of UEs may simultaneously access the slice subnet service

coverage-area-TA-list: string

A list of TrackingAreas where the NSSI can be selected.

ue-mobility-level: string

User mobility level, value can be stationary, nomadic, restricted mobility, fully mobility.

resource-sharing-level: string

Whether the resources to be allocated to the slice subnet instance may be shared with another network slice instance(s).

exp-data-rate-UL: integer

User experience data rate of upload.

exp-data-rate-DL: integer

User experience data rate of download.

area-traffic-cap-UL: integer

The area traffic capbility of upload.

area-traffic-cap-DL: integer

The area traffic capbility of download.

activity-factor: integer

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.

jitter: integer

The jitter requirements of network slice subnet.

survival-time: string

Survival time for network slice subnet.

max-bandwidth: integer

Maxmun bandwidth value of TN network.

exp-data-rate: integer

Expected date rate for uRLLC.

max-number-of-PDU-session: integer

maxNumberofPDUSession Integer 1 The maximum number of PDU sessions that can simultaneously/concurrently access to the network slice.

overall-user-density: integer

Overall User Density.

cs-reliability-mean-time: string

Communication service reliability mean time between failures.

msg-size-byte: string

Message size(byte) .

transfer-interval-target: string

transferIntervalTarget String 1 Target value of transfer interval.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

slice-profiles: object

Collection of slice subnet service profile.

slice-profile: object[]
slice-profile

snapshot: object

Openstack snapshot

  • TO cloud-region (PARENT of snapshot, snapshot BelongsTo cloud-region, MANY2ONE)
  • FROM vserver( vserver Uses snapshot, ONE2ONE)
snapshot-id: string

Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

snapshot-name: string

Snapshot name

snapshot-architecture: string

Operating system architecture

snapshot-os-distro: string

The common name of the operating system distribution in lowercase

snapshot-os-version: string

The operating system version as specified by the distributor.

application: string

The application that the image instantiates.

application-vendor: string

The vendor of the application.

application-version: string

The version of the application.

snapshot-selflink: string

URL to endpoint where AAI can get more details

prev-snapshot-id: string

This field contains the UUID of the previous snapshot (if any).

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

snapshots: object

Collection of openstack snapshots

snapshot: object[]
snapshot

software-version: object

Software Version

  • TO pnf (PARENT of software-version, software-version BelongsTo pnf, MANY2ONE)
software-version-id: string

Identifier of the software version

is-active-sw-ver: boolean

used to indicate whether or not this software-version is the active one (activeSw = true)

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

software-versions: object

Collection of software versions.

software-version: object[]
software-version

sp-partner: object

Instance of an sp-partner

  • TO service-instance( sp-partner PartOf service-instance, ONE2MANY)

    • For CCVPN Usecase

sp-partner-id: string

Uniquely identifies this sp-partner by id

url: string

Store the URL of this sp-partner.

callsource: string

Store the callsource of this sp-partner.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

operational-status: string

Store the operational-status for this sp-partner.

model-customization-id: string

Store the model-customization-id for this sp-partner.

model-invariant-id: string

the ASDC model id for this sp-partner model.

model-version-id: string

the ASDC model version for this sp-partner model.

relationship-list: object
relationship

sp-partners: object

Collection of sp-partners

sp-partner: object[]
sp-partner

sriov-pf: object

SR-IOV Physical Function

  • TO p-interface (PARENT of sriov-pf, sriov-pf BelongsTo p-interface, ONE2ONE)(4)
  • FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)

  • (4) IF this TO node is deleted, this SRIOV-PF is DELETED also
pf-pci-id: string

Identifier for the sriov-pf

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

sriov-pfs: object

Collection of SR-IOV Physical Functions.

sriov-pf: object[]
sriov-pf

sriov-vf: object

SR-IOV Virtual Function (not to be confused with virtual network function)

  • TO l-interface (PARENT of sriov-vf, sriov-vf BelongsTo l-interface, ONE2ONE)(4)
  • TO sriov-pf( sriov-vf Uses sriov-pf, MANY2ONE)

  • (4) IF this TO node is deleted, this SRIOV-VF is DELETED also
pci-id: string

PCI ID used to identify the sriov-vf

vf-vlan-filter: string

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

vf-mac-filter: string

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

vf-vlan-strip: boolean

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

vf-vlan-anti-spoof-check: boolean

This option ensures anti VLAN spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.

vf-mac-anti-spoof-check: boolean

This option ensures anti MAC spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.

vf-mirrors: string

This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.

vf-broadcast-allow: boolean

This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM

vf-unknown-multicast-allow: boolean

This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM

vf-unknown-unicast-allow: boolean

This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM

vf-insert-stag: boolean

This option, if set to true, instructs to insert outer tag after traffic comes out of VM.

vf-link-status: string

This option is used to set the link status. Valid values as of 1607 are on, off, and auto.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

neutron-network-id: string

Neutron network id of the interface

relationship-list: object
relationship

sriov-vfs: object

Collection of SR-IOV Virtual Functions.

sriov-vf: object[]
sriov-vf

start-node-filter: object

property-name: string
property-value: string

subnet: object

  • TO l3-network (PARENT of subnet, subnet BelongsTo l3-network, MANY2ONE)(4)
  • TO zone (PARENT of subnet, subnet BelongsTo zone, MANY2ONE)

    • A fabric subnet belongs to a zone.(4)

  • FROM bgp-group( bgp-group Destination subnet, MANY2ONE)

    • To node-type is destination of bgp-group.

  • FROM bgp-group( bgp-group Source subnet, MANY2ONE)

    • To node-type is source of bgp-group.

  • FROM bgp-neighbor (CHILD of subnet, bgp-neighbor BelongsTo subnet, MANY2ONE)

    • bgp-neighbor belongs To a subnet.(1)

  • FROM configuration( configuration Uses subnet, ONE2MANY)

    • A configuration uses a subnet

  • FROM host-route (CHILD of subnet, host-route BelongsTo subnet, MANY2ONE)(1)
  • FROM ip-address-list (CHILD of subnet, ip-address-list BelongsTo subnet, MANY2ONE)(1)
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
  • FROM network-route( network-route MemberOf subnet, MANY2ONE)

    • The route is part of part of a subnet.

  • FROM profile( profile AppliesTo subnet, MANY2MANY)

    • A profile (set of characteristics) applies to the subnet.

  • FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
  • FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf subnet, MANY2MANY)

  • (1) IF this SUBNET node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this SUBNET is DELETED also
  • SUBNET cannot be deleted if related to BGP-GROUP,L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
subnet-id: string

Subnet ID, should be UUID.

subnet-name: string

Name associated with the subnet.

neutron-subnet-id: string

Neutron id of this subnet

gateway-address: string

gateway ip address

network-start-address: string

network start address

cidr-mask: string

cidr mask

ip-version: string

ip version

orchestration-status: string

Orchestration status of this VNF, mastered by MSO

description: string

text used for documentation

dhcp-enabled: boolean

dhcp enabled

dhcp-start: string

the start address reserved for use by dhcp

dhcp-end: string

the last address reserved for use by dhcp

subnet-role: string

role of the subnet, referenced when assigning IPs

subnet-model: string

subnet model BGP, VRPP

ops-note: string

Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.

subnet-type: string

Subtype used to categorize this physical link

subnet-function: string

The function performed by this Linterface

ip-assignment-direction: string

ip address assignment direction of the subnet

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

subnet-sequence: integer

sequence of the subnet

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

configuration-status: string

Configuration status of the subnet.

host-routes: object[]
host-route
ip-address-list: object[]
ip-address-list
relationship-list: object
relationship
bgp-neighbors: object[]
bgp-neighbor

subnets: object

subnet: object[]
subnet

sw-component: object

create/update/delete the sw-component node

  • TO profile( sw-component AppliesTo profile, MANY2MANY)

    • The profile associated to a sw-component

  • FROM pnf( pnf MemberOf sw-component, MANY2ONE)

    • The sw-component associated to a pnf

  • FROM pserver( pserver MemberOf sw-component, MANY2ONE)

    • The sw-component associated to a pserver

  • FROM vserver( vserver MemberOf sw-component, MANY2ONE)

    • The sw-component associated to a vserver

sw-component-id: string

UUID

sw-component-name: string

Name of software component

sw-component-type: string

Type of software component

sw-component-role: string

Role of software component

sw-component-function: string

Function of software component

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

sw-components: object

sw-component: object[]
sw-component

tagged-inventory-item-list: object

inventory-item: object[]
inventory-item

temporary-parameter-list: object

Used to specify temporary parameters for p-interface, lag-interface, or l-interface objects.

  • TO l-interface (PARENT of temporary-parameter-list, temporary-parameter-list BindsTo l-interface, MANY2ONE)

    • used for generic interface parameters(4)

  • TO lag-interface (PARENT of temporary-parameter-list, temporary-parameter-list BindsTo lag-interface, MANY2ONE)

    • used for generic interface parameters(4)

  • TO p-interface (PARENT of temporary-parameter-list, temporary-parameter-list BindsTo p-interface, MANY2ONE)

    • used for generic interface parameters(4)

  • (4) IF this TO node is deleted, this TEMPORARY-PARAMETER-LIST is DELETED also
temporary-parameter-list-id: string

UUID - unique object identifier

param-group: string

temporary parameter group

param-name: string

temporary parameter name

param-value: string

temporary parameter value

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

temporary-parameter-lists: object

Collection of temporary parameter lists.

temporary-parameter-list: object[]
temporary-parameter-list

tenant: object

Openstack tenant

  • TO cloud-region (PARENT of tenant, tenant BelongsTo cloud-region, MANY2ONE)
  • TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
  • TO l3-network( tenant Uses l3-network, MANY2MANY)
  • TO volume-group( tenant DependsOn volume-group, ONE2MANY)
  • FROM generic-vnf( generic-vnf BelongsTo tenant, MANY2ONE)
  • FROM k8s-resource (CHILD of tenant, k8s-resource BelongsTo tenant, MANY2ONE)
  • FROM line-of-business( line-of-business Uses tenant, MANY2MANY)
  • FROM nos-server (CHILD of tenant, nos-server BelongsTo tenant, MANY2ONE)
  • FROM owning-entity( owning-entity Uses tenant, ONE2MANY)
  • FROM sdwan-vpn( sdwan-vpn PartOf tenant, ONE2MANY)

    • For CCVPN Usecase

  • FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
  • FROM vf-module( vf-module HostedOn tenant, MANY2ONE)
  • FROM vserver (CHILD of tenant, vserver BelongsTo tenant, MANY2ONE)

  • TENANT cannot be deleted if related to K8S-RESOURCE,NOS-SERVER,VSERVER
tenant-id: string

Unique id relative to the cloud-region.

tenant-name: string

Readable name of tenant

tenant-context: string

This field will store the tenant context.

parent-id: string

tenant parent-id

production-state: string

Production state

support-model: string

Support Model

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

vservers: object[]
vserver
nos-servers: object[]
nos-server
relationship-list: object
relationship
k8s-resources: object[]
k8s-resource

tenants: object

Collection of openstack tenants.

tenant: object[]
tenant

tunnel-termination-point: object

Instance of an tunnel termination point

  • TO interlayer-attachment( tunnel-termination-point LinksTo interlayer-attachment, MANY2MANY)

    • For CCVPN Usecase(4)

  • TO pnf( tunnel-termination-point BindsTo pnf, MANY2MANY)

    • For CCVPN Usecase(4)

  • FROM p-interface( p-interface BindsTo tunnel-termination-point, MANY2MANY)

    • For CCVPN Usecase(1)

  • (1) IF this TUNNEL-TERMINATION-POINT node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this TUNNEL-TERMINATION-POINT is DELETED also
ttp-id: string

Id that identifies the tunnel termination point

tunnel-tp-id: string

TTP ID discovered from controller

name: string

Name of tunnel termination point

admin-status: string

Admin status of TTP e.g, up,down,testing,preparing-maintenance,maintenance.

oper-status: string

Operational status of TTP e.g, up,down,testing,preparing-maintenance,maintenance.

switching-capability: string

Indicate switching capability of TTP e.g,PSC-1, EVPL,L2SC,TDM,OTN.

encoding: string

Encoding support by the TTP e.g, packet,ethernet,PDH,SDH,digital-wrapper,lambda,fiber,ODUK,line.

protection-type: string

Indicate supported protection type of this TTP e.g, unprotected,reroute,reroute-extra,1-for-n,unidir-1-to-1.

inter-layer-lock-id: integer

correlation between related objects in ETH and OTN topology.

selflink: string

Store the link to get more information for this object.

operational-status: string

Store the operational-status for this object.

model-customization-id: string

Store the model-customization-id for this object.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

tunnel-termination-points: object

Collection of Tunnel Termination Point.

tunnel-termination-point: object[]
tunnel-termination-point

tunnel-xconnect: object

Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted

  • TO allotted-resource (PARENT of tunnel-xconnect, tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)

  • (4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
id: string

Allotted Resource id UUID assigned to this instance.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Concurrency value

relationship-list: object
relationship

tunnel-xconnects: object

This object is used to store the specific tunnel cross connect aspects of an allotted resource

tunnel-xconnect: object[]
tunnel-xconnect

uni: object

Instance of an User network interface

  • TO generic-vnf( uni PartOf generic-vnf, MANY2MANY)

    • For CCVPN Usecase

  • TO p-interface( uni PartOf p-interface, MANY2MANY)

    • For CCVPN Usecase

  • FROM connectivity( connectivity PartOf uni, MANY2MANY)

    • For CCVPN Usecase -- ETree

id: string

Id that identifies the UNI

tp-id: string

Termination point ID.

cvlan: string

The cvlan for the site used for ethernet type connectivity.

selflink: string

Store the link to get more information for this object.

operational-status: string

Store the operational-status for this object.

model-customization-id: string

Store the model-customization-id for this object.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

unis: object

Collection of User network interface.

uni: object[]
uni

update: object

Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.

update-node-type: string
update-node-uri: string
update-node-key: object[]
update-node-key
action: object[]
action

update-node-key: object

key-name: string
key-value: string

validation-audit: object

validation audit, value of validation status

  • TO cloud-region (PARENT of validation-audit, validation-audit BelongsTo cloud-region, ONE2ONE)

    • The validation-audit associated to a cloud-region(4)

  • TO line-of-business( validation-audit AppliesTo line-of-business, MANY2ONE)

    • The line-of-business associated to a validation-audit

  • (4) IF this TO node is deleted, this VALIDATION-AUDIT is DELETED also
validation-id: string

Validation-Audit UUID

validation-request-id: string

Request-id to retrieve data from client related to the specified audit

validation-status: string

Status of the audit

validation-phase: string

Phase in the lifecycle of the configuration

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

validation-audits: object

Collection of validation-audit

validation-audit: object[]
validation-audit

vce: object

Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.

  • TO availability-zone( vce Uses availability-zone, MANY2MANY)
  • TO complex( vce LocatedIn complex, MANY2MANY)
  • TO vserver( vce HostedOn vserver, ONE2MANY)
  • FROM entitlement (CHILD of vce, entitlement BelongsTo vce, MANY2ONE)(1)
  • FROM license (CHILD of vce, license BelongsTo vce, MANY2ONE)(1)
  • FROM port-group (CHILD of vce, port-group BelongsTo vce, MANY2ONE)(1)
  • FROM service-instance( service-instance ComposedOf vce, ONE2MANY)

  • (1) IF this VCE node is deleted, this FROM node is DELETED also
vnf-id: string

Unique id of VNF. This is unique across the graph.

vnf-name: string

Name of VNF.

vnf-name2: string

Alternate name of VNF.

vnf-type: string

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.

service-id: string

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

regional-resource-zone: string

Regional way of organizing pservers, source of truth should define values

prov-status: string

Trigger for operational monitoring of this resource by Service Assurance systems.

operational-status: string

Indicator for whether the resource is considered operational

license-key: string

OBSOLETE - do not use

equipment-role: string

Network role being played by this VNF

orchestration-status: string

Orchestration status of this VNF, mastered by MSO

heat-stack-id: string

Heat stack id corresponding to this instance, managed by MSO

mso-catalog-key: string

Corresponds to the SDN-C catalog id used to configure this VCE

vpe-id: string

Unique ID of VPE connected to this VCE.

v6-vce-wan-address: string

Valid v6 IP address for the WAN Link on this router. Implied length of /64.

ipv4-oam-address: string

Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

ipv4-loopback0-address: string

Loopback0 address

entitlement-resource-uuid: string

OBSOLETE - see child relationships

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

port-groups: object[]
port-group
licenses: object[]
license
entitlements: object[]
entitlement
relationship-list: object
relationship

vces: object

Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.

vce: object[]
vce

vf-module: object

a deployment unit of VNFCs

  • TO generic-vnf (PARENT of vf-module, vf-module BelongsTo generic-vnf, MANY2ONE)(4)
  • TO k8s-resource( vf-module Uses k8s-resource, ONE2MANY)
  • TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
  • TO tenant( vf-module HostedOn tenant, MANY2ONE)
  • TO vnfc( vf-module Uses vnfc, ONE2MANY)(2)
  • TO volume-group( vf-module Uses volume-group, ONE2ONE)
  • TO vserver( vf-module Uses vserver, ONE2MANY)

  • (2) IF this VF-MODULE node is deleted, this TO node is DELETED also
  • (4) IF this TO node is deleted, this VF-MODULE is DELETED also
vf-module-id: string

Unique ID of vf-module.

vf-module-name: string

Name of vf-module

heat-stack-id: string

Heat stack id corresponding to this instance.

orchestration-status: string

orchestration status of this vf-module, mastered by MSO

is-base-vf-module: boolean

used to indicate whether or not this object is base vf module

automated-assignment: boolean

Indicates whether vf-module assignment was done via automation or manually

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

persona-model-version: string

the ASDC model version for this resource or service model.

model-customization-id: string

captures the id of all the configuration used to customize the resource for the service.

widget-model-id: string

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

widget-model-version: string

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

contrail-service-instance-fqdn: string

the Contrail unique ID for a service-instance

module-index: integer

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

selflink: string

Path to the controller object.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

operational-status: string

Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.

relationship-list: object
relationship

vf-modules: object

Collection of vf-modules, a deployment unit of VNFCs

vf-module: object[]
vf-module

vig-server: object

vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607

  • TO ipsec-configuration (PARENT of vig-server, vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)

  • (4) IF this TO node is deleted, this VIG-SERVER is DELETED also
vig-address-type: string

indicates whether the VIG is for AVPN or INTERNET

ipaddress-v4-vig: string

v4 IP of the vig server

ipaddress-v6-vig: string

v6 IP of the vig server

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

vig-servers: object

vig-server: object[]
vig-server

vip-ipv4-address-list: object

IPv4 Address Range

  • TO cloud-region (PARENT of vip-ipv4-address-list, vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
  • TO cp( vip-ipv4-address-list Uses cp, MANY2MANY)
  • TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
  • TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
  • FROM bgp-group( bgp-group Destination vip-ipv4-address-list, MANY2ONE)

    • To node-type is destination of bgp-group.

  • FROM bgp-group( bgp-group Source vip-ipv4-address-list, MANY2ONE)

    • To node-type is source of bgp-group.

  • FROM bgp-neighbor( bgp-neighbor Uses vip-ipv4-address-list, MANY2ONE)

    • bgp-neighbor uses To node-type.

  • FROM fqdn( fqdn AppliesTo vip-ipv4-address-list, ONE2ONE)

    • The fqdn that applies to a vip-ipv4-address-list.

  • FROM ip-address-list( ip-address-list Uses vip-ipv4-address-list, ONE2ONE)

    • 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

  • FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)

  • VIP-IPV4-ADDRESS-LIST cannot be deleted if related to BGP-GROUP,BGP-NEIGHBOR,IP-ADDRESS-LIST
vip-ipv4-address: string

IP address

vip-ipv4-prefix-length: integer

Prefix length, 32 for single address

vlan-id-inner: integer

Inner VLAN tag

vlan-id-outer: integer

Outer VLAN tag

is-floating: boolean

Indicator of fixed or floating address

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

neutron-network-id: string

Neutron network id of the interface that address belongs to

neutron-subnet-id: string

Neutron id of subnet that address belongs to

ops-note: string

Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

vip-ipv6-address-list: object

IPv6 Address Range

  • TO cloud-region (PARENT of vip-ipv6-address-list, vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
  • TO cp( vip-ipv6-address-list Uses cp, MANY2MANY)
  • TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
  • TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
  • FROM bgp-group( bgp-group Destination vip-ipv6-address-list, MANY2ONE)

    • To node-type is destination of bgp-group.

  • FROM bgp-group( bgp-group Source vip-ipv6-address-list, MANY2ONE)

    • To node-type is source of bgp-group.

  • FROM bgp-neighbor( bgp-neighbor Uses vip-ipv6-address-list, MANY2ONE)

    • bgp-neighbor uses To node-type.

  • FROM fqdn( fqdn AppliesTo vip-ipv6-address-list, ONE2ONE)

    • The fqdn that applies to a vip-ipv6-address-list.

  • FROM ip-address-list( ip-address-list Uses vip-ipv6-address-list, ONE2ONE)

    • 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

  • FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)

  • VIP-IPV6-ADDRESS-LIST cannot be deleted if related to BGP-GROUP,BGP-NEIGHBOR,IP-ADDRESS-LIST
vip-ipv6-address: string

IP address

vip-ipv6-prefix-length: integer

Prefix length, 128 for single address

vlan-id-inner: integer

Inner VLAN tag

vlan-id-outer: integer

Outer VLAN tag

is-floating: boolean

Indicator of fixed or floating address

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

neutron-network-id: string

Neutron network id of the interface that address belongs to

neutron-subnet-id: string

Neutron id of subnet that address belongs to

ops-note: string

Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

virtual-data-center: object

Virtual organization of cloud infrastructure elements in a data center context

  • FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
  • FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
  • FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
vdc-id: string

Unique ID of the vdc

vdc-name: string

Name of the virtual data center

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

virtual-data-centers: object

Virtual organization of cloud infrastructure elements in a data center context

virtual-data-center: object[]
virtual-data-center

vlan: object

Definition of vlan

  • TO l-interface (PARENT of vlan, vlan LinksTo l-interface, MANY2ONE)(4)
  • TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
  • TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
  • FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
  • FROM l3-interface-ipv4-address-list (CHILD of vlan, l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
  • FROM l3-interface-ipv6-address-list (CHILD of vlan, l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
  • FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)

  • (1) IF this VLAN node is deleted, this FROM node is DELETED also
  • (2) IF this VLAN node is deleted, this TO node is DELETED also
  • (4) IF this TO node is deleted, this VLAN is DELETED also
vlan-interface: string

String that identifies the interface

vlan-id-inner: integer

Inner VLAN tag

vlan-id-outer: integer

Outer VLAN tag

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

speed-value: string

Captures the numeric part of the speed

speed-units: string

Captures the units corresponding to the speed

vlan-type: string

The type of vlan (eg. vxlan)

vlan-description: string

Used to describe (the service associated with) the vlan

backdoor-connection: string

Whether customer is going to use this VLAN for backdoor connection to another customer premise device.

vpn-key: string

This indicates the customers VPN ID associated with this vlan

orchestration-status: string

Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.

in-maint: boolean

used to indicate whether or not this object is in maintenance mode (maintenance mode = true)

prov-status: string

Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].

is-ip-unnumbered: boolean

Flag indicating the interface uses the IP Unnumbered configuration.

is-private: boolean

Private VLAN indicator.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship
l3-interface-ipv4-address-list: object[]
l3-interface-ipv4-address-list
l3-interface-ipv6-address-list: object[]
l3-interface-ipv6-address-list

vlan-characteristic: object

describes an vlan characteristic

  • TO vlan-tag( vlan-characteristic AppliesTo vlan-tag, MANY2MANY)
vlan-characteristic-id: string

UUID.

root-name: string

Name.

applies-to: string

Device role the vlan-characteristic applies to (c-agg-leaf-a, c-agg-leaf-b, r-leaf).

dhcp-pool: boolean

DHCP Agent access.

internet-access: boolean

Boolean to represent if requires internet access.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

vlan-characteristics: object

Collection of vlan characteristics

vlan-characteristic: object[]
vlan-characteristic

vlan-mapping: object

vlan-mapping object is an optional child object of the forwarder-evc object. A given forwarder-evc object may have multiple vlan-mapping objects.

  • TO forwarder-evc (PARENT of vlan-mapping, vlan-mapping BelongsTo forwarder-evc, MANY2ONE)(4)

  • (4) IF this TO node is deleted, this VLAN-MAPPING is DELETED also
vlan-mapping-id: string

Key for vlan-mapping object.

uni-cvlan: string

CVLAN value from the UNI/ingress side of the SAREA gateway access device.

nni-svlan: string

SVLAN value from the NNI/egress side of the SAREA gateway access device.

nni-cvlan: string

CVLAN value from the NNI/egress side of the SAREA gateway access device.

ivlan: string

The internal VLAN ('IVLAN') value. Specific to Arista devices.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string
relationship-list: object
relationship

vlan-mappings: object

Collection of vlan mappings.

vlan-mapping: object[]
vlan-mapping

vlan-range: object

Definition of vlan range

  • TO cloud-region (PARENT of vlan-range, vlan-range BelongsTo cloud-region, MANY2ONE)

    • A vlan range belongs to a cloud-region.(4)

  • TO zone (PARENT of vlan-range, vlan-range BelongsTo zone, MANY2ONE)

    • The vlan-range is located in a zone.(4)

  • FROM line-of-business( line-of-business Uses vlan-range, ONE2MANY)

    • A line-of uses a vlan-range

  • FROM owning-entity( owning-entity Uses vlan-range, ONE2MANY)

    • An owning-entity uses a vlan-range.

  • FROM profile( profile AppliesTo vlan-range, MANY2MANY)

    • A profile (set of characteristics) applies to the vlan-range.

  • FROM vlan-tag (CHILD of vlan-range, vlan-tag BelongsTo vlan-range, MANY2ONE)

    • A vlan-tag belongs to a vlan-range.(1)

  • (1) IF this VLAN-RANGE node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this VLAN-RANGE is DELETED also
vlan-range-id: string

vlan id in range UUID.

vlan-id-lower: integer

vlan id in range lower

vlan-id-upper: integer

vlan id in range upper

vlan-type: string

vlan type

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

vlan-tags: object[]
vlan-tag
relationship-list: object
relationship

vlan-ranges: object

vlan-range: object[]
vlan-range

vlan-tag: object

vlan tag information

  • TO cloud-region( vlan-tag BelongsTo cloud-region, MANY2ONE)
  • TO cp( vlan-tag Uses cp, MANY2MANY)
  • TO vlan-range (PARENT of vlan-tag, vlan-tag BelongsTo vlan-range, MANY2ONE)

    • A vlan-tag belongs to a vlan-range.(4)

  • FROM l-interface( l-interface Uses vlan-tag, MANY2MANY)

    • An sub-interface that uses a vlan-tag.

  • FROM l3-network( l3-network Uses vlan-tag, MANY2MANY)

    • A l3-network Uses vlan-tag.

  • FROM policy( policy AppliesTo vlan-tag, MANY2MANY)

    • 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.

  • FROM profile( profile AppliesTo vlan-tag, MANY2MANY)

    • A profile (set of characteristics) applies to the vlan-tag.

  • FROM vlan-characteristic( vlan-characteristic AppliesTo vlan-tag, MANY2MANY)

  • (4) IF this TO node is deleted, this VLAN-TAG is DELETED also
  • VLAN-TAG cannot be deleted if related to L-INTERFACE
vlan-tag-id: string

Vlan Tag Id

vlan-tag-role: string

Role assigned to this vlan-tag

vlan-id-inner: integer

Inner VLAN tag

vlan-id-outer: integer

Outer VLAN tag

is-private: boolean

is private flag.

vlan-tag-type: string

VLAN tag Type

vlan-tag-function: string

VLAN Tag Function

config-phase: string

The config-phase associated with this vlan-tag

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

vlan-tags: object

Vlan Tags Assigned out of a Vlan Range

vlan-tag: object[]
vlan-tag

vlans: object

vlan: object[]
vlan

vnf: object

Abstract vnf class

vnf-id: string

Unique id of VNF. This is unique across the graph.

vnf-image: object

Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.

  • FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)

  • VNF-IMAGE cannot be deleted if related to GENERIC-VNF
vnf-image-uuid: string

Unique ID of this asset

application: string

The application that the image instantiates.

application-vendor: string

The vendor of the application.

application-version: string

The version of the application.

selflink: string

URL to endpoint where AAI can get more details

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

vnf-images: object

Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.

vnf-image: object[]
vnf-image

vnfc: object

  • TO cp (PARENT of vnfc, vnfc BelongsTo cp, ONE2MANY)

    • cp is child of vnfc(2)

  • TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
  • TO instance-group( vnfc MemberOf instance-group, MANY2MANY)
  • TO vip-ipv4-address-list( vnfc Uses vip-ipv4-address-list, MANY2MANY)
  • TO vip-ipv6-address-list( vnfc Uses vip-ipv6-address-list, MANY2MANY)
  • TO vserver( vnfc HostedOn vserver, ONE2MANY)
  • FROM configuration( configuration Uses vnfc, ONE2ONE)(1)
  • FROM l3-interface-ipv4-address-list (CHILD of vnfc, l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(1)
  • FROM l3-interface-ipv6-address-list (CHILD of vnfc, l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(1)
  • FROM vf-module( vf-module Uses vnfc, ONE2MANY)(3)

  • (1) IF this VNFC node is deleted, this FROM node is DELETED also
  • (2) IF this VNFC node is deleted, this TO node is DELETED also
  • (3) IF this FROM node is deleted, this VNFC is DELETED also
  • (4) IF this TO node is deleted, this VNFC is DELETED also
vnfc-name: string

Unique ID of vnfc.

nfc-naming-code: string

Short code that is used in naming instances of the item being modeled

nfc-function: string

English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service

prov-status: string

prov status of this vnfc

orchestration-status: string

Orchestration status of this VNF, mastered by APP-C

ipaddress-v4-oam-vip: string

Oam V4 vip address of this vnfc

in-maint: boolean

used to indicate whether or not this object is in maintenance mode (maintenance mode = true)

is-closed-loop-disabled: boolean

used to indicate whether closed loop function is enabled on this node

group-notation: string

Group notation of VNFC

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

model-customization-id: string

captures the id of all the configuration used to customize the resource for the service.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship
cps: object[]
cp
l3-interface-ipv4-address-list: object[]
l3-interface-ipv4-address-list
l3-interface-ipv6-address-list: object[]
l3-interface-ipv6-address-list

vnfcs: object

virtual network components associated with a vserver from application controller.

vnfc: object[]
vnfc

volume: object

Ephemeral Block storage volume.

  • FROM vserver (PARENT of volume, vserver AttachesTo volume, ONE2MANY)(3)

  • (3) IF this FROM node is deleted, this VOLUME is DELETED also
volume-id: string

Unique ID of block storage volume relative to the vserver.

volume-selflink: string

URL to endpoint where AAI can get more details

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

volume-group: object

Persistent block-level storage.

  • TO cloud-region (PARENT of volume-group, volume-group BelongsTo cloud-region, MANY2ONE)
  • TO complex( volume-group LocatedIn complex, MANY2ONE)
  • FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
  • FROM tenant( tenant DependsOn volume-group, ONE2MANY)
  • FROM vf-module( vf-module Uses volume-group, ONE2ONE)
volume-group-id: string

Unique ID of volume-group.

volume-group-name: string

Name of the volume group.

heat-stack-id: string

Heat stack id corresponding to this volume-group

vnf-type: string

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: string

Orchestration status of this volume-group

model-customization-id: string

captures the id of all the configuration used to customize the resource for the service.

vf-module-model-customization-id: string

helps relate the volume group to the vf-module whose components will require the volume group

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

volume-groups: object

Collection of persistent block-level storage.

volume-group: object[]
volume-group

volumes: object

Collection of ephemeral Block storage volumes.

volume: object[]
volume

vpls-pe: object

VPLS Provider Edge routers.

  • TO complex( vpls-pe LocatedIn complex, MANY2ONE)
  • TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
  • FROM lag-interface (CHILD of vpls-pe, lag-interface BindsTo vpls-pe, MANY2ONE)(1)
  • FROM p-interface (CHILD of vpls-pe, p-interface BindsTo vpls-pe, MANY2ONE)(1)

  • (1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
equipment-name: string
prov-status: string

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

ipv4-oam-address: string

Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).

equipment-role: string

Client should send valid enumerated value, e.g., VPLS-PE.

vlan-id-outer: integer

Temporary location for stag to get to VCE

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship
p-interfaces: object[]
p-interface
lag-interfaces: object[]
lag-interface

vpls-pes: object

Collection of VPLS Provider Edge routers

vpls-pe: object[]
vpls-pe

vpn-binding: object

VPN binding

  • TO aggregate-route( vpn-binding Uses aggregate-route, ONE2MANY)

    • A vpn-binding uses many aggregate routes

  • TO customer( vpn-binding Uses customer, MANY2MANY)
  • TO ext-aai-network( vpn-binding BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • TO p-interface( vpn-binding BindsTo p-interface, ONE2MANY)

    • For CCVPN Usecase

  • FROM allotted-resource( allotted-resource BelongsTo vpn-binding, MANY2MANY)
  • FROM configuration( configuration Uses vpn-binding, MANY2ONE)
  • FROM connectivity( connectivity BindsTo vpn-binding, MANY2MANY)

    • For CCVPN Usecase

  • FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
  • FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
  • FROM network-resource( network-resource Uses vpn-binding, ONE2MANY)

    • For CCVPN Usecase

  • FROM policy( policy Uses vpn-binding, ONE2MANY)

    • A policy uses vpn-bindings

  • FROM profile( profile AppliesTo vpn-binding, MANY2MANY)

    • A profile (set of characteristics) applies to the vpn-binding.

  • FROM route-target (CHILD of vpn-binding, route-target BelongsTo vpn-binding, MANY2ONE)(1)
  • FROM sdwan-vpn( sdwan-vpn PartOf vpn-binding, ONE2MANY)

    • For CCVPN Usecase

  • FROM vrf( vrf AppliesTo vpn-binding, MANY2ONE)

    • A vrf uses a vpn-binding.

  • (1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also
  • VPN-BINDING cannot be deleted if related to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
vpn-id: string

VPN ID, globally unique within A&AI

vpn-name: string

VPN Name

vpn-platform: string

the platform associated with the VPN example AVPN, Mobility

vpn-type: string

Type of the vpn, should be taken from enumerated/valid values

vpn-region: string

region of customer vpn

customer-vpn-id: string

id for this customer vpn

route-distinguisher: string

Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.

access-provider-id: string

Store the id of the access provider of this vpn.

access-client-id: string

Store the id of the access client of this vpn.

access-topology-id: string

Store the id of the access topology of this vpn.

src-access-node-id: string

Store the id of the src-access-node of this vpn.

src-access-ltp-id: string

Store the id of the src-access-ltp of this vpn.

dst-access-node-id: string

Store the id of the dst-access-node of this vpn.

dst-access-ltp-id: string

Store the id of the dst-access-ltp of this vpn.

operational-status: string

Store the operational-status of this vpn service.

admin-status: string

Store the admin-status of this vpn service.

protection-type: string

Store the protection-type of this vpn service.

slice-id: string

Store the ID of the transport slice to which this vpn service may belong.

switching-type: string

Store the type of multiplexing used for this vpn service.

src-tpn: string

Store source tributary port number of the underlay OTN tunnel realizing this vpn service.

dst-tpn: string

Store destination tributary port number of the underlay OTN tunnel realizing this vpn service.

model-customization-id: string

Store the model-customization-id for this object.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

max-prefix-v4: integer

Max prefix for IPv4.

max-prefix-v6: integer

Max prefix for IPv6.

max-prefix-threshold: integer

Max prefix threshold.

label-mode-v4: string

Label mode for IPv4.

label-mode-v6: string

Label mode for IPv6.

vpn-description: string

The description of the vpn.

vxlan-network-id: string

A VNI associated with the VPN.

ops-note: string

Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.

max-path: string

A variable BGP max AS path length.

max-paths-v4: integer

stores maximum number of paths for IPv4.

max-paths-v6: integer

stores maximum number of paths for IPv6.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

route-targets: object[]
route-target
relationship-list: object
relationship

vpn-bindings: object

vpn-binding: object[]
vpn-binding

vrf: object

Definition of vrf

  • TO instance-group( vrf Primary instance-group, MANY2MANY)

    • used for vrf fallback

  • TO instance-group( vrf Secondary instance-group, MANY2MANY)

    • used for vrf fallback

  • TO l-interface( vrf Uses l-interface, ONE2MANY)
  • TO l3-network( vrf Uses l3-network, ONE2MANY)

    • A vrf uses many l3-networks

  • TO network-route( vrf Uses network-route, MANY2MANY)

    • Relates vrf to network-route for static routes.

  • TO next-hop( vrf Uses next-hop, MANY2MANY)

    • The vrfs that are used by the next-hop.

  • TO pnf (PARENT of vrf, vrf BelongsTo pnf, MANY2ONE)

    • A vrf belongs to a pnf.(4)

  • TO vpn-binding( vrf AppliesTo vpn-binding, MANY2ONE)

    • A vrf uses a vpn-binding.

  • FROM aggregate-route (CHILD of vrf, aggregate-route BelongsTo vrf, MANY2ONE)

    • An aggregate-route BelongsTo a vrf.(1)

  • FROM bgp-group (CHILD of vrf, bgp-group BelongsTo vrf, MANY2ONE)

    • A bgp-group belongs to a pnf.(1)

  • FROM bgp-neighbor (CHILD of vrf, bgp-neighbor BelongsTo vrf, MANY2ONE)

    • A bgp-neighbor belongs to a vrf.(1)

  • FROM configuration( configuration Uses vrf, MANY2MANY)

    • A Configuration uses VRFs

  • FROM object-group( object-group AppliesTo vrf, MANY2MANY)

    • The object-group to VRF for various route types.

  • FROM policy( policy AppliesTo vrf, MANY2MANY)
  • FROM profile( profile AppliesTo vrf, MANY2MANY)

    • A profile (set of characteristics) applies to the vrf.

  • FROM route-target (CHILD of vrf, route-target BelongsTo vrf, MANY2ONE)(1)
  • FROM service-instance( service-instance ComposedOf vrf, MANY2MANY)

    • This edge relates a vrf that is configured on a pnf to the service-instances that the vrf supports.

  • (1) IF this VRF node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this VRF is DELETED also
  • VRF cannot be deleted if related to INSTANCE-GROUP,NETWORK-ROUTE
vrf-id: string

VRF UUID.

vrf-name: string

VRF Name

vrf-description: string

VRF Description

route-distinguisher: string

Route Distinguisher

vrf-type: string

The type of vrf (bridge-domain as an example)

vrf-address-family: string

IP address family (v6/v4/both)

ops-note: string

Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

vrf-role: string

Indicator for the use of this physical link

vrf-function: string

The function performed by this Linterface

vrf-group-name: string

Bridge domain group name

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

best-external: string

Identifies best-external vrf, best-external=Y if the conditions are met. otherwise, best-external = N

max-prefix-v4: integer

Max prefix for IPv4.

max-prefix-v6: integer

Max prefix for IPv6.

max-prefix-threshold-v4: integer

Max prefix threshold for IPv4.

max-prefix-threshold-v6: integer

Max prefix threshold for IPv6.

label-mode-v4: string

Label mode for IPv4.

label-mode-v6: string

Label mode for IPv6.

max-paths-v4: integer

stores maximum number of paths for IPv4.

max-paths-v6: integer

stores maximum number of paths for IPv6.

v4-max-path-type: string

Type of v4-max-path

v6-max-path-type: string

Type of v6-max-path

configuration-status: string

Configuration status of the vrf

bgp-groups: object[]
bgp-group
bgp-neighbors: object[]
bgp-neighbor
aggregate-routes: object[]
aggregate-route
route-targets: object[]
route-target
relationship-list: object
relationship

vrfs: object

vrf: object[]
vrf

vserver: object

Virtual Servers, aka virtual machine or VM.

  • TO flavor( vserver Uses flavor, MANY2ONE)
  • TO image( vserver Uses image, MANY2ONE)
  • TO instance-group( vserver MemberOf instance-group, MANY2MANY)
  • TO pserver( vserver HostedOn pserver, MANY2ONE)
  • TO snapshot( vserver Uses snapshot, ONE2ONE)
  • TO sw-component( vserver MemberOf sw-component, MANY2ONE)

    • The sw-component associated to a vserver

  • TO tenant (PARENT of vserver, vserver BelongsTo tenant, MANY2ONE)
  • TO volume (PARENT of vserver, vserver AttachesTo volume, ONE2MANY)(2)
  • FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
  • FROM l-interface (CHILD of vserver, l-interface BindsTo vserver, MANY2ONE)(1)
  • FROM profile( profile supports vserver, MANY2MANY)
  • FROM vce( vce HostedOn vserver, ONE2MANY)
  • FROM vf-module( vf-module Uses vserver, ONE2MANY)
  • FROM vnfc( vnfc HostedOn vserver, ONE2MANY)

  • (1) IF this VSERVER node is deleted, this FROM node is DELETED also
  • (2) IF this VSERVER node is deleted, this TO node is DELETED also
vserver-id: string

Unique identifier for this vserver relative to its tenant

vserver-name: string

Name of vserver

vserver-name2: string

Alternative name of vserver

prov-status: string

Trigger for operational monitoring of this resource by Service Assurance systems.

vserver-selflink: string

URL to endpoint where AAI can get more details

in-maint: boolean

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.

is-closed-loop-disabled: boolean

Used to indicate whether closed loop function is enabled on this node

numa: string

Non-uniform memory access optimization, helps prevent memory-bandwidth bottlenecks. Expected values - 1 or 2 identifying memory access

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

operational-status: string

Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.

volumes: object[]
volume
relationship-list: object
relationship
l-interfaces: object[]
l-interface

vservers: object

Collection of virtual Servers, aka virtual machines or VMs.

vserver: object[]
vserver

wan-port-config: object

Instance of a wan-port-config

  • TO ext-aai-network( wan-port-config BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • TO generic-vnf( wan-port-config PartOf generic-vnf, MANY2MANY)

    • For CCVPN Usecase

  • TO service-instance( wan-port-config PartOf service-instance, MANY2MANY)

    • For CCVPN Usecase

wan-port-config-id: string

Uniquely identifies this wan-port-config by id

wan-port-config-name: string

Store the name of this wan-port-config.

device-id: string

Store the id of the device of this wan-port-config.

vlan-id: string

Store the id of the vlan of this wan-port-config.

ip-address: string

Store the ip-address of this wan-port-config.

ipv4-address: string

Store the ipv4-address of this wan-port-config.

ipv6-address: string

Store the ipv6-address of this wan-port-config.

provider-ip-address: string

Store the provider-ip-address of this wan-port-config.

provider-ipv4-address: string

Store the provider-ipv4-address of this wan-port-config.

provider-ipv6-address: string

Store the provider-ipv6-address of this wan-port-config.

input-bandwidth: string

Store the input-bandwidth of this wan-port-config.

output-bandwidth: string

Store the output-bandwidth of this wan-port-config.

description: string

Store the description of this wan-port-config.

port-type: string

Store the port-type of this wan-port-config.

port-number: string

Store the port-number of this wan-port-config.

transport-network-name: string

Store the transport-network-name of this wan-port-config.

device-port-id: string

Store the device-port-id of this wan-port-config.

wan-port-id: string

Store the wan-port-id of this wan-port-config.

selflink: string

Store the link to get more information for this object.

operational-status: string

Store the operational-status for this object.

model-customization-id: string

Store the model-customization-id for this object.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship

wan-port-configs: object

Collection of wan-port-configs

wan-port-config: object[]
wan-port-config

zone: object

A zone is a grouping of assets in a location homing to the same connections into the CBB

  • TO complex( zone LocatedIn complex, MANY2ONE)
  • TO endpoint( zone Uses endpoint, MANY2MANY)
  • TO service-instance( zone Uses service-instance, MANY2MANY)
  • TO zone( zone AppliesTo zone, MANY2MANY)

    • the zone is associated to another zone.

  • FROM autonomous-system( autonomous-system LocatedIn zone, MANY2ONE)

    • A local autonomous-system is located in a zone.(1)

  • FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
  • FROM contact( contact Supports zone, ONE2MANY)

    • The contact supports a zone.

  • FROM network-range( network-range LocatedIn zone, MANY2MANY)

    • The network-range is located in a zone

  • FROM object-group( object-group LocatedIn zone, MANY2MANY)

    • The object-group is located in a zone

  • FROM pnf( pnf LocatedIn zone, MANY2ONE)
  • FROM pserver( pserver LocatedIn zone, MANY2ONE)
  • FROM service-instance( service-instance LocatedIn zone, MANY2ONE)
  • FROM subnet (CHILD of zone, subnet BelongsTo zone, MANY2ONE)

    • A fabric subnet belongs to a zone.(1)

  • FROM vlan-range (CHILD of zone, vlan-range BelongsTo zone, MANY2ONE)

    • The vlan-range is located in a zone.(1)

  • FROM zone( zone AppliesTo zone, MANY2MANY)

    • the zone is associated to another zone.

  • (1) IF this ZONE node is deleted, this FROM node is DELETED also
  • ZONE cannot be deleted if related to ENDPOINT
zone-id: string

Code assigned by AIC to the zone

zone-name: string

English name associated with the zone

zone-type: string

The type of zone (ex. AIC or NC).

design-type: string

Design of zone [Medium/Large]

zone-context: string

Context of zone [production/test]

status: string

Status of a zone.

zone-role: string

Role of a zone.

zone-function: string

Function of a zone.

zone-number: integer

Zone number identifier for multi-zone locations.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

resource-version: string

Concurrency value

in-maint: boolean

Used to indicate whether or not zone object is in maintenance mode.

relationship-list: object
relationship
subnets: object[]
subnet
vlan-ranges: object[]
vlan-range

zones: object

Collection of zones

zone: object[]
zone

zzzz-patch-action: object

action-type: string

zzzz-patch-action-data: object

property-name: string
property-value: string

zzzz-patch-activity: object

describes an activities

  • TO cloud-region (PARENT of activity, activity AppliesTo cloud-region, MANY2MANY)

    • The activity applies to a cloud-region.(4)

  • TO mapping( activity AppliesTo mapping, MANY2MANY)

    • The reservation information associated with a NAT Pool mapping.

  • TO network-range (PARENT of activity, activity BelongsTo network-range, MANY2ONE)

    • An activity is being performed on a network-range.(4)

  • TO p-interface (PARENT of activity, activity AppliesTo p-interface, MANY2MANY)

    • The activity applies to a p-interface.(4)

  • TO pnf (PARENT of activity, activity AppliesTo pnf, MANY2MANY)

    • The activity applies to a pnf.(4)

  • TO pserver (PARENT of activity, activity AppliesTo pserver, MANY2MANY)

    • The activity applies to a pserver.(4)

  • FROM activity-state (CHILD of activity, activity-state BelongsTo activity, MANY2ONE)

    • An activity-state is tracks the state of an activity.(1)

  • (1) IF this ACTIVITY node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this ACTIVITY is DELETED also
activity-id: string

Unique id for the activity. (UUID)

activity-type: string

Type of activity (ex, provisioning).

activity-name: string

Name of the activity.

activity-creator: string

Application that created the activity.

activity-description: string

Description of activity.

timestamp: string

Date and Time activity is created.

current-state: string

Current state of the activity.

reflected-state: string

State reflected by the database.

activity-role: string

Role

activity-function: string

Function

timestamp-last-updated: string

Date/time last updated

timestamp-expiration: string

Date/time expires

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-activity-state: object

describes an activities

  • TO activity (PARENT of activity-state, activity-state BelongsTo activity, MANY2ONE)

    • An activity-state is tracks the state of an activity.(4)

  • (4) IF this TO node is deleted, this ACTIVITY-STATE is DELETED also
state-order: integer

Order for the activity state.

state-name: string

Name of the activity state (ex, NVT-PROV).

state-view: string

View of the activity state.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-address-family: object

Definition of address family

  • TO bgp-group (PARENT of address-family, address-family BelongsTo bgp-group, MANY2ONE)

    • Address Family belongs to a bgp-group(4)

  • TO bgp-neighbor (PARENT of address-family, address-family BelongsTo bgp-neighbor, MANY2ONE)

    • Address Family belongs to a bgp-neighbor(4)

  • FROM policy( policy AppliesTo address-family, MANY2MANY)

    • A policy applies to an address family.

  • (4) IF this TO node is deleted, this ADDRESS-FAMILY is DELETED also
address-family-id: string

address family UUID.

af-type: string

address family type (aka afi)

af-subtype: string

address family subtype (aka safi)

af-role: string

role of address-family

af-function: string

function of address-family

max-prefix-v4: integer

Max prefix for IPv4

max-prefix-v6: integer

Max prefix for IPv6

max-prefix-threshold: integer

Max prefix threshold

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-aggregate-route: object

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.

  • TO l3-network (PARENT of aggregate-route, aggregate-route BelongsTo l3-network, MANY2ONE)(4)
  • TO vrf (PARENT of aggregate-route, aggregate-route BelongsTo vrf, MANY2ONE)

    • An aggregate-route BelongsTo a vrf.(4)

  • FROM vpn-binding( vpn-binding Uses aggregate-route, ONE2MANY)

    • A vpn-binding uses many aggregate routes

  • (4) IF this TO node is deleted, this AGGREGATE-ROUTE is DELETED also
agg-route-id: string

Route UUID.

network-start-address: string

Name of the forwarding-path

cidr-mask: string

CIDR-mask for aggregate route subnet

ip-version: string

Identifies is aggregate route is ipv4 or ipv6

network-address: string

Network Address

next-hop: string

Next Hop

route-path: string

Route Path

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-aggregated-ether-option: object

Used to specify the aggregated Ethernet properties of a specific aggregated Ethernet interface.

  • TO lag-interface (PARENT of aggregated-ether-option, aggregated-ether-option BindsTo lag-interface, ONE2ONE)

    • used for generic interface parameters(4)

  • FROM lacp (CHILD of aggregated-ether-option, lacp BindsTo aggregated-ether-option, ONE2ONE)

    • used for generic interface parameters(1)

  • (1) IF this AGGREGATED-ETHER-OPTION node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this AGGREGATED-ETHER-OPTION is DELETED also
aggregated-ether-option-id: string

UUID - unique object identifier

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-allotted-resource: object

Represents a slice or partial piece of a resource that gets separately allotted

  • TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)

    • AAI-1925

  • TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
  • TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
  • TO l-interface( allotted-resource Uses l-interface, ONE2MANY)
  • TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
  • TO logical-link( allotted-resource ComposedOf logical-link, ONE2MANY)(2)
  • TO network-policy( allotted-resource Uses network-policy, ONE2ONE)
  • TO p-interface( allotted-resource Uses p-interface, ONE2MANY)

    • AAI-1925 For CCVPN Usecase

  • TO service-instance (PARENT of allotted-resource, allotted-resource BelongsTo service-instance, MANY2ONE)(4)
  • TO vlan( allotted-resource PartOf vlan, MANY2MANY)
  • TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY)
  • FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)

    • AAI-1925

  • FROM configuration( configuration Uses allotted-resource, MANY2ONE)
  • FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
  • FROM site-resource( site-resource Uses allotted-resource, MANY2MANY)

    • For CCVPN Usecase

  • FROM tunnel-xconnect (CHILD of allotted-resource, tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)

  • (1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
  • (2) IF this ALLOTTED-RESOURCE node is deleted, this TO node is DELETED also
  • (4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
id: string

Allotted Resource id UUID assigned to this instance.

description: string

The descriptive information assigned to this allotted resource instance

selflink: string

Link back to more information in the controller

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

orchestration-status: string

Orchestration status

operational-status: string

Indicator for whether the resource is considered operational

type: string

Generic description of the type of allotted resource.

role: string

role in the network that this resource will be providing.

allotted-resource-name: string

Store the name of this allotted-resource.

access-provider-id: string

Store the id of the access provider of this allotted-resource.

access-client-id: string

Store the id of the access client of this allotted-resource.

access-topology-id: string

Store the id of the access topology of this allotted-resource.

access-node-id: string

Store the id of the access node of this allotted-resource.

access-ltp-id: string

Store the id of the access ltp of this allotted-resource.

cvlan: string

Store the cvlan of this allotted-resource.

vpn-name: string

Store the vpn-name of this allotted-resource.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-autonomous-system: object

Description of Autonomous System

  • TO zone( autonomous-system LocatedIn zone, MANY2ONE)

    • A local autonomous-system is located in a zone.(4)

  • FROM bgp-group( bgp-group Destination autonomous-system, MANY2ONE)

    • To node-type is destination of bgp-group.

  • FROM bgp-group( bgp-group Source autonomous-system, MANY2ONE)

    • To node-type is source of bgp-group.

  • FROM bgp-neighbor( bgp-neighbor MemberOf autonomous-system, MANY2ONE)

    • bgp-neighbor is a member of an autonomous-system.

  • FROM pnf( pnf LocatedIn autonomous-system, MANY2ONE)

    • pnf is located in the autonomous-system.

  • (4) IF this TO node is deleted, this AUTONOMOUS-SYSTEM is DELETED also
  • AUTONOMOUS-SYSTEM cannot be deleted if related to BGP-GROUP,BGP-NEIGHBOR,PNF
autonomous-system-id: string

UUID

autonomous-system-number: integer

asn in the range of 0 to 9223372036854775807

autonomous-system-type: string

type (global vs. local).

autonomous-system-region: string

geographic region

autonomous-system-role: string

role of autonomous system

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-availability-zone: object

Availability zone, a collection of compute hosts/pservers

  • TO cloud-region (PARENT of availability-zone, availability-zone BelongsTo cloud-region, MANY2ONE)(4)
  • TO complex( availability-zone LocatedIn complex, MANY2ONE)
  • TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
  • FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
  • FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
  • FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
  • FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
  • FROM vce( vce Uses availability-zone, MANY2MANY)

  • (4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
  • AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
availability-zone-name: string

Name of the availability zone. Unique across a cloud region

hypervisor-type: string

Type of hypervisor. Source of truth should define valid values.

operational-status: string

State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-available-bandwidth: object

Instance of an available-bandwidth-map

  • TO bandwidth-attribute (PARENT of available-bandwidth, available-bandwidth BelongsTo bandwidth-attribute, MANY2ONE)

    • For MDONS usecase(4)

  • (4) IF this TO node is deleted, this AVAILABLE-BANDWIDTH is DELETED also
ab-id: string

Id that identifies the attribute

odu-type: string

ODU Type that identifies the ODU Eg. ODU0, ODU1, ODU2, ODU3, ODU4

number: integer

The value of available bandwidth. Applicable only for ENNI.

selflink: string

Store the link to get more information for this object.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-bandwidth-attribute: object

Instance of a bandwidth-attribute

  • TO p-interface (PARENT of bandwidth-attribute, bandwidth-attribute BelongsTo p-interface, MANY2ONE)

    • For MDONS usecase(4)

  • FROM available-bandwidth (CHILD of bandwidth-attribute, available-bandwidth BelongsTo bandwidth-attribute, MANY2ONE)

    • For MDONS usecase(1)

  • (1) IF this BANDWIDTH-ATTRIBUTE node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this BANDWIDTH-ATTRIBUTE is DELETED also
bwa-id: string

Id that identifies the bandwidth attribute

selflink: string

Store the link to get more information for this object.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-bfd: 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.

  • FROM next-hop( next-hop Uses bfd, ONE2ONE)
bfd-id: string

Unique identifier.

bfd-type: string

Used to categorize this object in conjunction with role & function. The most generic category.

bfd-role: string

Used to categorize this object in conjunction with type & function.

bfd-function: string

Used to categorize this object in conjunction with type & role. The most specific category.

bfd-keep-alive: string

bfd keep-alive parameter

bfd-timeout: string

bfd timeout parameter

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

bfd-multihop: string

bfd multihop parameter

relationship-list: object
relationship

zzzz-patch-bgp-group: object

Definition of bgp-group

  • TO autonomous-system( bgp-group Destination autonomous-system, MANY2ONE)

    • To node-type is destination of bgp-group.

  • TO autonomous-system( bgp-group Source autonomous-system, MANY2ONE)

    • To node-type is source of bgp-group.

  • TO l3-interface-ipv4-address-list( bgp-group Destination l3-interface-ipv4-address-list, MANY2ONE)

    • To node-type is destination of bgp-group.

  • TO l3-interface-ipv4-address-list( bgp-group Source l3-interface-ipv4-address-list, MANY2ONE)

    • To node-type is source of bgp-group.

  • TO l3-interface-ipv6-address-list( bgp-group Destination l3-interface-ipv6-address-list, MANY2ONE)

    • To node-type is destination of bgp-group.

  • TO l3-interface-ipv6-address-list( bgp-group Source l3-interface-ipv6-address-list, MANY2ONE)

    • To node-type is source of bgp-group.

  • TO pnf (PARENT of bgp-group, bgp-group BelongsTo pnf, MANY2ONE)

    • A bgp-group belongs to a pnf.(4)

  • TO subnet( bgp-group Destination subnet, MANY2ONE)

    • To node-type is destination of bgp-group.

  • TO subnet( bgp-group Source subnet, MANY2ONE)

    • To node-type is source of bgp-group.

  • TO vip-ipv4-address-list( bgp-group Destination vip-ipv4-address-list, MANY2ONE)

    • To node-type is destination of bgp-group.

  • TO vip-ipv4-address-list( bgp-group Source vip-ipv4-address-list, MANY2ONE)

    • To node-type is source of bgp-group.

  • TO vip-ipv6-address-list( bgp-group Destination vip-ipv6-address-list, MANY2ONE)

    • To node-type is destination of bgp-group.

  • TO vip-ipv6-address-list( bgp-group Source vip-ipv6-address-list, MANY2ONE)

    • To node-type is source of bgp-group.

  • TO vrf (PARENT of bgp-group, bgp-group BelongsTo vrf, MANY2ONE)

    • A bgp-group belongs to a pnf.(4)

  • FROM address-family (CHILD of bgp-group, address-family BelongsTo bgp-group, MANY2ONE)

    • Address Family belongs to a bgp-group(1)

  • FROM bgp-neighbor( bgp-neighbor MemberOf bgp-group, MANY2ONE)

    • bgp-neighbor is a member of an bgp-group.

  • FROM generic-vnf (PARENT of bgp-group, generic-vnf BelongsTo bgp-group, MANY2ONE)

    • The bgp-group associated to a generic-vnf.(3)

  • FROM policy( policy AppliesTo bgp-group, MANY2MANY)

    • A policy applies to a bgp-group.

  • (1) IF this BGP-GROUP node is deleted, this FROM node is DELETED also
  • (3) IF this FROM node is deleted, this BGP-GROUP is DELETED also
  • (4) IF this TO node is deleted, this BGP-GROUP is DELETED also
  • BGP-GROUP cannot be deleted if related to BGP-NEIGHBOR
bgp-group-id: string

UUID.

bgp-group-name: string

name of bgp-group

bgp-group-type: string

type of bgp-group

bgp-group-role: string

role of bgp-group

bgp-group-function: string

function of bgp-group

local-as: integer

local a-s number type of vrf (bridge-domain as an example)

local-address: string

local address

peer-as: integer

peer a-s number

peer-address: string

peer address

description: string

description of bgp-group

ops-note: string

Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-bgp-neighbor: object

Definition of bgp-neighbor

  • TO autonomous-system( bgp-neighbor MemberOf autonomous-system, MANY2ONE)

    • bgp-neighbor is a member of an autonomous-system.

  • TO bgp-group( bgp-neighbor MemberOf bgp-group, MANY2ONE)

    • bgp-neighbor is a member of an bgp-group.

  • TO l3-interface-ipv4-address-list( bgp-neighbor Uses l3-interface-ipv4-address-list, MANY2ONE)

    • bgp-neighbor uses To node-type.

  • TO l3-interface-ipv6-address-list( bgp-neighbor Uses l3-interface-ipv6-address-list, MANY2ONE)

    • bgp-neighbor uses To node-type.

  • TO logical-link( bgp-neighbor LinksTo logical-link, MANY2ONE)

    • A policy applies to a bgp-neighbor.

  • TO pnf (PARENT of bgp-neighbor, bgp-neighbor BelongsTo pnf, MANY2ONE)

    • A bgp-neighbor belongs to a pnf.(4)

  • TO subnet (PARENT of bgp-neighbor, bgp-neighbor BelongsTo subnet, MANY2ONE)

    • bgp-neighbor belongs To a subnet.(4)

  • TO vip-ipv4-address-list( bgp-neighbor Uses vip-ipv4-address-list, MANY2ONE)

    • bgp-neighbor uses To node-type.

  • TO vip-ipv6-address-list( bgp-neighbor Uses vip-ipv6-address-list, MANY2ONE)

    • bgp-neighbor uses To node-type.

  • TO vrf (PARENT of bgp-neighbor, bgp-neighbor BelongsTo vrf, MANY2ONE)

    • A bgp-neighbor belongs to a vrf.(4)

  • FROM address-family (CHILD of bgp-neighbor, address-family BelongsTo bgp-neighbor, MANY2ONE)

    • Address Family belongs to a bgp-neighbor(1)

  • FROM configuration( configuration Uses bgp-neighbor, MANY2MANY)

    • The configuration Uses bgp-neighbor.

  • FROM generic-vnf (PARENT of bgp-neighbor, generic-vnf BelongsTo bgp-neighbor, MANY2ONE)

    • The bgp-neighbor associated to a generic-vnf.(3)

  • FROM policy( policy AppliesTo bgp-neighbor, MANY2MANY)

    • A policy applies to a bgp-neighbor.

  • (1) IF this BGP-NEIGHBOR node is deleted, this FROM node is DELETED also
  • (3) IF this FROM node is deleted, this BGP-NEIGHBOR is DELETED also
  • (4) IF this TO node is deleted, this BGP-NEIGHBOR is DELETED also
bgp-neighbor-id: string

UUID.

bgp-neighbor-type: string

name of bgp-group

bgp-neighbor-role: string

type of bgp-group

bgp-neighbor-function: string

role of bgp-group

local-as: integer

local a-s number type of vrf (bridge-domain as an example)

local-address: string

local address

peer-as: integer

peer a-s number

peer-address: string

peer address

description: string

description of bgp-group

ops-note: string

Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.

prov-status: string

provisioning status. Valid values [PREPROV/NVTPROV/PROV].

peer-hostname: string

hostname of the peer

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-cable: object

Definition of cable

  • TO complex (PARENT of cable, cable LocatedIn complex, MANY2ONE)

    • A cable is located in a complex.(4)

  • TO hardware-catalog-item( cable IsA hardware-catalog-item, MANY2ONE)

    • The cable is this item from the hardware-catalog.

  • TO physical-link( cable ComposedOf physical-link, ONE2MANY)

    • A cable is composed of one or more physical-links.

  • FROM pluggable( pluggable PartOf cable, MANY2ONE)

    • A pluggable that is intergrated with a cable.(1)

  • FROM port( port LinksTo cable, MANY2ONE)

    • A channel-interface terminates a channel-link.

  • (1) IF this CABLE node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this CABLE is DELETED also
cable-name: string

A unique name for the channel-link relative to the physical-link.

cable-type: string

The type of cable.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-card: object

Definition of card

  • TO card-slot (PARENT of card, card LocatedIn card-slot, ONE2ONE)

    • A card is located in a card-slot.(4)

  • TO hardware-catalog-item( card IsA hardware-catalog-item, MANY2ONE)

    • The card is described by the hardware-catalog-item.

  • FROM pluggable-slot (CHILD of card, pluggable-slot LocatedIn card, MANY2ONE)

    • A pluggable slot is located in a card.(1)

  • FROM port (CHILD of card, port LocatedIn card, MANY2ONE)

    • A port is located in a card.(1)

  • FROM profile( profile AppliesTo card, MANY2MANY)

    • The profile (set of characteristics) applies to the card.

  • (1) IF this CARD node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this CARD is DELETED also
card-type: string

The type of card.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-card-slot: object

Definition of card-slot

  • TO chassis (PARENT of card-slot, card-slot LocatedIn chassis, MANY2ONE)

    • A card-slot is located in a chassis.(4)

  • FROM card (CHILD of card-slot, card LocatedIn card-slot, ONE2ONE)

    • A card is located in a card-slot.(1)

  • (1) IF this CARD-SLOT node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this CARD-SLOT is DELETED also
slot-name: string

The name of the card-slot (unique relative to the chassis).

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-chassis: object

Definition of chassis

  • TO complex( chassis LocatedIn complex, MANY2ONE)

    • A chassis LinksTo a complex.

  • TO hardware-catalog-item( chassis IsA hardware-catalog-item, MANY2ONE)

    • The chassis is described by the hardware-catalog-item.

  • TO pnf( chassis PartOf pnf, MANY2ONE)

    • A chassis is part of a pnf.

  • TO pserver( chassis PartOf pserver, MANY2MANY)

    • A chassis is part of a pserver.

  • TO rack( chassis LocatedIn rack, MANY2ONE)

    • A chassis is LocatedIn a rack.

  • TO rack-unit( chassis Uses rack-unit, ONE2MANY)

    • A chassis uses space in a rack (aka one or more rack-units).

  • FROM card-slot (CHILD of chassis, card-slot LocatedIn chassis, MANY2ONE)

    • A card-slot is located in a chassis.(1)

  • FROM license (CHILD of chassis, license BelongsTo chassis, MANY2ONE)

    • A license belongs to a chassis.(1)

  • FROM pluggable-slot (CHILD of chassis, pluggable-slot LocatedIn chassis, MANY2ONE)

    • A pluggable-slot is located in a chassis.(1)

  • FROM port (CHILD of chassis, port LocatedIn chassis, MANY2ONE)

    • A port is LocatedIn a chassis.(1)

  • FROM profile( profile AppliesTo chassis, MANY2MANY)

    • The profile (set of characteristics) applies to the chassis.

  • (1) IF this CHASSIS node is deleted, this FROM node is DELETED also
chassis-name: string

A globally unique name for the chassis.

chassis-type: string

The type of chassis..

chassis-role: string

The role of the chassis relative to the pnf/pserver..

operating-system: string

Operating system of the hardware.

serial-number: string

The serial number of the chassis..

asset-tag: string

The asset tag of the chassis.

chassis-description: string

Description of the chassis.

part-number: string

Part number for this chassis.

orchestration-status: string

Orchestration status of this chassis.

equip-model: string

Equipment model.

equip-vendor: string

Equipment vendor. Source of truth should define valid values.

equip-identifier: string

CLEI or other specification for chassis hardware.

slot-number: integer

Slot number associated with this chassis.

admin-state: string

Reflects the admin-state of the device.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-class-map: object

Class map related to a policy map member used for QOS

  • FROM class-map-member( class-map-member MemberOf class-map, MANY2ONE)

    • Member of class map

  • FROM policy-map-member( policy-map-member Uses class-map, MANY2MANY)

    • Class-map related to policy-map-member

  • CLASS-MAP cannot be deleted if related to CLASS-MAP-MEMBER
class-map-id: string

unique ID

class-map-name: string

name of class-map

class-map-type: string

valid values are TRAFFIC or default

class-map-role: string

valid values are MATCH-ALL or MATCH-ANY

class-map-function: string

function of class-map

direction: string

direction set as ingress or egress

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-class-map-member: object

Member of a class map

  • TO parameter-list( class-map-member Uses parameter-list, MANY2MANY)

    • class-map-member to parameter-list

  • TO class-map( class-map-member MemberOf class-map, MANY2ONE)

    • Member of class map

  • CLASS-MAP-MEMBER cannot be deleted if related to PARAMETER-LIST
class-map-member-id: string

unique ID

sequence-number: string

numeric indicating the sequence of the member

member-type: string

valid values are action or end-class-map

action: string

valid value is match

action-type: string

describes the action-type

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-class-of-service: object

Captures data and voice protocols to differentiate the types of payloads contained in the packet being transmitted.

  • TO site-pair (PARENT of class-of-service, class-of-service BelongsTo site-pair, MANY2ONE)(4)

  • (4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
cos: string

unique identifier of probe

probe-id: string

identifier of probe

probe-type: string

type of probe

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-cloud-region: object

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.

  • TO complex( cloud-region LocatedIn complex, MANY2ONE)
  • TO endpoint( cloud-region Uses endpoint, MANY2MANY)
  • TO geo-region( cloud-region MemberOf geo-region, MANY2MANY)

    • The cloud-region associated to a geo-region

  • TO instance-group( cloud-region Uses instance-group, ONE2MANY)
  • TO l3-network( cloud-region Uses l3-network, MANY2MANY)
  • TO network-technology( cloud-region Uses network-technology, MANY2MANY)
  • TO policy( cloud-region Implements policy, MANY2MANY)

    • a cloud-region implements policies

  • TO project( cloud-region PartOf project, MANY2ONE)

    • The cloud-region is part of a project (ex, project that built out the cloud region).

  • TO service-instance( cloud-region Uses service-instance, MANY2MANY)
  • TO zone( cloud-region LocatedIn zone, MANY2ONE)
  • FROM activity (CHILD of cloud-region, activity AppliesTo cloud-region, MANY2MANY)

    • The activity applies to a cloud-region.(1)

  • FROM availability-zone (CHILD of cloud-region, availability-zone BelongsTo cloud-region, MANY2ONE)(1)
  • FROM contact( contact Supports cloud-region, ONE2MANY)

    • The contact supports a cloud-region.

  • FROM dvs-switch (CHILD of cloud-region, dvs-switch BelongsTo cloud-region, MANY2ONE)
  • FROM esr-system-info (CHILD of cloud-region, esr-system-info BelongsTo cloud-region, MANY2ONE)(1)
  • FROM flavor (CHILD of cloud-region, flavor BelongsTo cloud-region, MANY2ONE)
  • FROM generic-vnf( generic-vnf LocatedIn cloud-region, MANY2ONE)
  • FROM group-assignment (CHILD of cloud-region, group-assignment BelongsTo cloud-region, MANY2ONE)
  • FROM host-aggregate (CHILD of cloud-region, host-aggregate BelongsTo cloud-region, MANY2ONE)(1)
  • FROM hpa-capability (CHILD of cloud-region, hpa-capability BelongsTo cloud-region, MANY2ONE)
  • FROM image (CHILD of cloud-region, image BelongsTo cloud-region, MANY2ONE)
  • FROM line-of-business( line-of-business Uses cloud-region, MANY2MANY)
  • FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
  • FROM mapping( mapping LocatedIn cloud-region, MANY2MANY)

    • The mapping associated to a cloud-region

  • FROM network-range( network-range LocatedIn cloud-region, MANY2MANY)

    • The network-range is located in a cloud-region

  • FROM oam-network (CHILD of cloud-region, oam-network BelongsTo cloud-region, MANY2ONE)
  • FROM object-group( object-group LocatedIn cloud-region, MANY2MANY)

    • The object-group is located in a cloud-region

  • FROM pnf( pnf LocatedIn cloud-region, MANY2ONE)

    • A pnf is located in (aka supports) a cloud-region.

  • FROM pnf( pnf Uses cloud-region, MANY2MANY)

    • used for CSP pnf to cloud-region.

  • FROM profile( profile AppliesTo cloud-region, MANY2MANY)
  • FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
  • FROM snapshot (CHILD of cloud-region, snapshot BelongsTo cloud-region, MANY2ONE)
  • FROM tenant (CHILD of cloud-region, tenant BelongsTo cloud-region, MANY2ONE)
  • FROM validation-audit (CHILD of cloud-region, validation-audit BelongsTo cloud-region, ONE2ONE)

    • The validation-audit associated to a cloud-region(1)

  • FROM vip-ipv4-address-list (CHILD of cloud-region, vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
  • FROM vip-ipv6-address-list (CHILD of cloud-region, vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
  • FROM vlan-range (CHILD of cloud-region, vlan-range BelongsTo cloud-region, MANY2ONE)

    • A vlan range belongs to a cloud-region.(1)

  • FROM vlan-tag( vlan-tag BelongsTo cloud-region, MANY2ONE)
  • FROM volume-group (CHILD of cloud-region, volume-group BelongsTo cloud-region, MANY2ONE)

  • (1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
  • CLOUD-REGION cannot be deleted if related to ENDPOINT,DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,HPA-CAPABILITY,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
cloud-owner: string

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

cloud-region-id: string

Identifier used by the vendor for the region. Second part of composite key

cloud-type: string

Type of the cloud (e.g., openstack)

owner-defined-type: string

Cloud-owner defined type indicator (e.g., dcp, lcp)

cloud-region-version: string

Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.

identity-url: string

URL of the keystone identity service

cloud-zone: string

Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.

complex-name: string

complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.

sriov-automation: string

Whether the cloud region supports (true) or does not support (false) SR-IOV automation.

cloud-extra-info: string

ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.

cloud-region-number: integer

Number that maps to the letter at the end of the cloud-region-id.

cloud-function: string

Function of cloud-region.

cloud-role: string

Role of cloud-region.

ops-note: string

Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.

cloud-region-number-definition: string

The alias used for this cloud.

status: string

Status of cloud-region.

upgrade-cycle: string

Upgrade cycle for the cloud region. For AIC regions upgrade cycle is designated by A,B,C etc.

orchestration-disabled: boolean

Used to indicate whether orchestration is enabled for this cloud-region.

in-maint: boolean

Used to indicate whether or not cloud-region object is in maintenance mode.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-collection: object

represents the collection resource in the TOSCA model

  • FROM instance-group( instance-group BelongsTo collection, ONE2ONE)
  • FROM service-instance( service-instance ComposedOf collection, ONE2ONE)
collection-id: string

Collection Object UUID

model-invariant-id: string

ASDC model id for this resource or service model

model-version-id: string

Model Version

collection-name: string

collection name

collection-type: string

Collection type

collection-role: string

Collection Role

collection-function: string

Collection function

orchestration-status: string

orchestration status

collection-customization-id: string

Captures the id of all the configuration used to customize the resource for the service

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-communication-service-profile: object

Requirement of comunication service.

  • TO service-instance (PARENT of communication-service-profile, communication-service-profile BelongsTo service-instance, ONE2ONE)
profile-id: string

ID of the profile.

max-number-of-UEs: integer

The maximum number of UEs may simultaneously access the communication service

coverage-area-list: string

A list of TrackingAreas where the NSI can be selected.

latency: integer

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.

exp-data-rate-UL: integer

User experience data rate of upload.

exp-data-rate-DL: integer

User experience data rate of download.

ue-mobility-level: string

User mobility level, value can be stationary, nomadic, restricted mobility, fully mobility.

resource-sharing-level: string

Whether the resources to be allocated to the network slice instance may be shared with another network slice instance(s).

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-community-list: object

Community List

  • TO object-group (PARENT of community-list, community-list BelongsTo object-group, MANY2ONE)(4)

  • (4) IF this TO node is deleted, this COMMUNITY-LIST is DELETED also
community-value: string

String value

type: string

String type

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-complex: object

Collection of physical locations that can house cloud-regions.

  • TO endpoint( complex Uses endpoint, MANY2MANY)
  • TO geo-region( complex MemberOf geo-region, MANY2MANY)

    • The complex associated to a geo-region

  • TO l3-network( complex Uses l3-network, MANY2MANY)
  • FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
  • FROM cable (CHILD of complex, cable LocatedIn complex, MANY2ONE)

    • A cable is located in a complex.(1)

  • FROM chassis( chassis LocatedIn complex, MANY2ONE)

    • A chassis LinksTo a complex.

  • FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
  • FROM contact( contact Supports complex, ONE2MANY)

    • The contact supports a complex.

  • FROM ctag-pool (CHILD of complex, ctag-pool BelongsTo complex, MANY2ONE)(1)
  • FROM generic-vnf( generic-vnf LocatedIn complex, MANY2MANY)
  • FROM network-range( network-range LocatedIn complex, MANY2MANY)

    • The network-range is located in a complex

  • FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
  • FROM object-group( object-group LocatedIn complex, MANY2MANY)

    • The object-group is located in a complex

  • FROM pnf( pnf LocatedIn complex, MANY2ONE)
  • FROM pserver( pserver LocatedIn complex, MANY2ONE)
  • FROM rack (CHILD of complex, rack LocatedIn complex, MANY2ONE)

    • A rack is located in a complex (aka building).(1)

  • FROM site-resource( site-resource Uses complex, MANY2MANY)

    • For CCVPN Usecase

  • FROM vce( vce LocatedIn complex, MANY2MANY)
  • FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
  • FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
  • FROM zone( zone LocatedIn complex, MANY2ONE)

  • (1) IF this COMPLEX node is deleted, this FROM node is DELETED also
  • COMPLEX cannot be deleted if related to ENDPOINT,AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
physical-location-id: string

Unique identifier for physical location, e.g., CLLI

data-center-code: string

Data center code which can be an alternate way to identify a complex

complex-name: string

Gamma complex name for LCP instance.

identity-url: string

URL of the keystone identity service

physical-location-type: string

Type, e.g., central office, data center.

time-zone: string

The time zone where the complex is located.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

street1: string
street2: string
city: string
state: string
postal-code: string
country: string
region: string
latitude: string
longitude: string
elevation: string
lata: string
relationship-list: object
relationship

zzzz-patch-composed-resource: object

Represents a resource that acts as a bridge between service-instance to define parent-child relationship

  • TO service-instance (PARENT of composed-resource, composed-resource ComposedOf service-instance, MANY2ONE)(4)
  • FROM service-instance( service-instance BelongsTo composed-resource, ONE2ONE)

  • (4) IF this TO node is deleted, this COMPOSED-RESOURCE is DELETED also
id: string

Composed Resource id UUID assigned to this instance.

description: string

The descriptive information assigned to this composed resource instance

selflink: string

Link back to more information in the controller

orchestration-status: string

Orchestration status

operational-status: string

Indicator for whether the resource is considered operational

type: string

Generic description of the type of composed resource.

role: string

role in the network that this resource will be providing.

composed-resource-name: string

Store the name of this composed-resource.

access-provider-id: string

Store the id of the access provider of this composed-resource.

access-client-id: string

Store the id of the access client of this composed-resource.

access-topology-id: string

Store the id of the access topology of this composed-resource.

access-node-id: string

Store the id of the access node of this composed-resource.

access-ltp-id: string

Store the id of the access ltp of this composed-resource.

cvlan: string

Store the cvlan of this composed-resource.

vpn-name: string

Store the vpn-name of this composed-resource.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-configuration: object

Generic configuration object.

  • TO allotted-resource( configuration Uses allotted-resource, MANY2ONE)
  • TO bgp-neighbor( configuration Uses bgp-neighbor, MANY2MANY)

    • The configuration Uses bgp-neighbor.

  • TO configuration( configuration BindsTo configuration, ONE2ONE)
  • TO instance-group( configuration PartOf instance-group, MANY2ONE)
  • TO l-interface( configuration AppliesTo l-interface, MANY2MANY)
  • TO l3-network( configuration PartOf l3-network, MANY2MANY)
  • TO lag-interface( configuration AppliesTo lag-interface, MANY2ONE)
  • TO logical-link( configuration Uses logical-link, ONE2MANY)
  • TO network-route( configuration Uses network-route, MANY2MANY)

    • Relates configuration to network-route for static routes.

  • TO pnf( configuration AppliesTo pnf, MANY2MANY)
  • TO policy( configuration Uses policy, MANY2MANY)

    • A configuration uses a policy

  • TO subnet( configuration Uses subnet, ONE2MANY)

    • A configuration uses a subnet

  • TO vnfc( configuration Uses vnfc, ONE2ONE)(4)
  • TO vpn-binding( configuration Uses vpn-binding, MANY2ONE)
  • TO vrf( configuration Uses vrf, MANY2MANY)

    • A Configuration uses VRFs

  • FROM configuration( configuration BindsTo configuration, ONE2ONE)
  • FROM evc (CHILD of configuration, evc BelongsTo configuration, ONE2ONE)(1)
  • FROM forwarder( forwarder Uses configuration, ONE2ONE)(3)
  • FROM forwarder-evc (CHILD of configuration, forwarder-evc BelongsTo configuration, ONE2ONE)(1)
  • FROM forwarding-path( forwarding-path Uses configuration, ONE2ONE)(3)
  • FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
  • FROM metadatum (CHILD of configuration, metadatum BelongsTo configuration, MANY2ONE)(1)
  • FROM service-instance( service-instance Uses configuration, ONE2MANY)
  • FROM service-instance( service-instance ComposedOf configuration, MANY2MANY)

  • (1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
  • (3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
  • (4) IF this TO node is deleted, this CONFIGURATION is DELETED also
  • CONFIGURATION cannot be deleted if related to NETWORK-ROUTE
configuration-id: string

UUID assigned to configuration.

management-option: string

Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.

configuration-name: string

Name of the configuration.

configuration-type: string

port-mirroring-configuration.

configuration-sub-type: string

vprobe, pprobe.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

orchestration-status: string

Orchestration status of the configuration.

operational-status: string

Indicator for whether the resource is considered operational.

configuration-selflink: string

URL to endpoint where AAI can get more details from SDN-GC.

model-customization-id: string

id of the configuration used to customize the resource

tunnel-bandwidth: string

DHV Site Effective Bandwidth

vendor-allowed-max-bandwidth: string

Velocloud Nominal Throughput - VNT

config-policy-name: string

Used to capture the name of the fabric configuration policy that was used to generate the payload sent to PINC for fabric configuration.

configuration-role: string

Used to categorize the configuration.

configuration-function: string

Used to categorize the configuration.

primary-role: boolean

Used by some configurations to identify if it's filling a primary role.

orchestration-version: string

Used to categorize the configuration.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-connectivity: object

Instance of a connectivity

  • TO connectivity( connectivity LinksTo connectivity, MANY2MANY)

    • For CCVPN Usecase -- ETree super and slave connectivity

  • TO ext-aai-network( connectivity BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • TO generic-vnf( connectivity PartOf generic-vnf, MANY2MANY)

    • For CCVPN Usecase

  • TO service-instance( connectivity PartOf service-instance, MANY2MANY)

    • For CCVPN Usecase

  • TO uni( connectivity PartOf uni, MANY2MANY)

    • For CCVPN Usecase -- ETree

  • TO vpn-binding( connectivity BindsTo vpn-binding, MANY2MANY)

    • For CCVPN Usecase

  • FROM connectivity( connectivity LinksTo connectivity, MANY2MANY)

    • For CCVPN Usecase -- ETree super and slave connectivity

connectivity-id: string

Uniquely identifies this connectivity by id

bandwidth-profile-name: string

Store the name of a bandwidth profile.

vpn-type: string

Store the type of a bandwidth profile.

cir: string

Store the CIR of this connectivity.

eir: string

Store the EIR of this connectivity.

cbs: string

Store the CBS of this connectivity.

ebs: string

Store the EBS of this connectivity.

color-aware: string

Store the color-awareness of this connectivity.

coupling-flag: string

Store the coupling flag of this connectivity.

etht-svc-name: string

The ethernet service name for this connectivity.

access-provider-id: string

Store the id of the access provider of this connectivity.

access-client-id: string

Store the id of the access client of this connectivity.

access-topology-id: string

Store the id of the access topology of this connectivity.

access-node-id: string

Store the id of the access node of this connectivity.

access-ltp-id: string

Store the id of the access ltp of this connectivity.

connectivity-selflink: string

Store the link to get more information for this connectivity.

cvlan: string

Store the cvlan for this connectivity.

operational-status: string

Store the operational-status of this connectivity.

admin-status: string

Store the admin-status of this connectivity.

protection-type: string

Store the protection-type of this connectivity.

slice-id: string

Store the ID of the transport slice to which this connectivity may belong.

model-customization-id: string

Store the model-customization-id for this object.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

relationship-list: object
relationship

zzzz-patch-connector: object

Collection of resource instances used to connect a variety of disparate inventory widgets

  • TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
  • FROM metadatum (CHILD of connector, metadatum BelongsTo connector, MANY2ONE)(1)
  • FROM service-instance( service-instance Uses connector, MANY2MANY)

  • (1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
resource-instance-id: string

Unique id of resource instance.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

widget-model-id: string

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

widget-model-version: string

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-constrained-element-set: object

This is how we would capture constraints defining allowed sets of elements.

  • TO model-constraint (PARENT of constrained-element-set, constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
  • TO model-element (PARENT of constrained-element-set, constrained-element-set BelongsTo model-element, MANY2ONE)(4)
  • FROM element-choice-set (CHILD of constrained-element-set, element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)

  • (1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
constrained-element-set-uuid: string
data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

constraint-type: string
check-type: string
relationship-list: object
relationship

zzzz-patch-contact: object

Contacts store the vendor information and have a relationship to the generic-vnf. In 1902, this will be populated by SDN-GC

  • TO cloud-region( contact Supports cloud-region, ONE2MANY)

    • The contact supports a cloud-region.

  • TO complex( contact Supports complex, ONE2MANY)

    • The contact supports a complex.

  • TO generic-vnf( contact supports generic-vnf, MANY2MANY)
  • TO pnf( contact Supports pnf, ONE2MANY)

    • The contact supports a pnf.

  • TO pserver( contact Supports pserver, ONE2MANY)

    • The contact supports a pserver.

  • TO zone( contact Supports zone, ONE2MANY)

    • The contact supports a zone.

  • CONTACT cannot be deleted if related to CLOUD-REGION,COMPLEX,PNF,PSERVER,ZONE
contact-name: string

Name of the contact

contact-telephone: string

Tel no. of contact

contact-email: string

e-mail of contact

vendor-type: string

NI (Network Integrator)SI (System Integrator) 3rd Party LCM

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-cp: object

Captures the point of attachment from services or resources to a virtual link or network.

  • FROM l-interface( l-interface LinksTo cp, ONE2ONE)
  • FROM l3-interface-ipv4-address-list (CHILD of cp, l3-interface-ipv4-address-list BelongsTo cp, MANY2ONE)(1)
  • FROM l3-interface-ipv6-address-list (CHILD of cp, l3-interface-ipv6-address-list BelongsTo cp, MANY2ONE)(1)
  • FROM l3-network( l3-network LinksTo cp, MANY2MANY)
  • FROM metadatum( metadatum AppliesTo cp, MANY2MANY)

    • AAI-2154 For BBS Usecase

  • FROM vip-ipv4-address-list( vip-ipv4-address-list Uses cp, MANY2MANY)
  • FROM vip-ipv6-address-list( vip-ipv6-address-list Uses cp, MANY2MANY)
  • FROM vlan-tag( vlan-tag Uses cp, MANY2MANY)
  • FROM vnfc (PARENT of cp, vnfc BelongsTo cp, ONE2MANY)

    • cp is child of vnfc(3)

  • (1) IF this CP node is deleted, this FROM node is DELETED also
  • (3) IF this FROM node is deleted, this CP is DELETED also
cp-instance-id: string

Unique ID of the connection point.

port-id: integer

port index to represent multiple CPs on VNFC connected to same network.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-ctag-assignment: object

  • TO l3-network (PARENT of ctag-assignment, ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
  • FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)

  • (4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
vlan-id-inner: integer

id.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-ctag-pool: object

A collection of C tags (vlan tags) grouped for a specific purpose.

  • TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
  • TO complex (PARENT of ctag-pool, ctag-pool BelongsTo complex, MANY2ONE)(4)
  • FROM generic-vnf( generic-vnf Uses ctag-pool, MANY2MANY)
  • FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)

  • (4) IF this TO node is deleted, this CTAG-POOL is DELETED also
target-pe: string

The Target provider edge router

availability-zone-name: string

Name of the availability zone

ctag-pool-purpose: string

Describes what the intended purpose of this pool is.

ctag-values: string

Comma separated list of ctags

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-customer: object

customer identifiers to provide linkage back to BSS information.

  • FROM service-subscription (CHILD of customer, service-subscription BelongsTo customer, MANY2ONE)

    • service-subscription BelongsTo customer(1)

  • FROM vpn-binding( vpn-binding Uses customer, MANY2MANY)

  • (1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
global-customer-id: string

Global customer id used across ONAP to uniquely identify customer.

subscriber-name: string

Subscriber name, an alternate way to retrieve a customer.

subscriber-type: string

Subscriber type, a way to provide VID with only the INFRA customers.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-cvlan-tag-entry: object

cvlan-tag: integer

See mis-na-virtualization-platform.yang

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-device: object

Instance of a device

  • TO ext-aai-network( device BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • TO generic-vnf( device Uses generic-vnf, ONE2MANY)

    • For CCVPN Usecase

  • TO service-instance( device PartOf service-instance, ONE2MANY)

    • For CCVPN Usecase

device-id: string

Uniquely identifies this device by id

esn: string

Store the esn of this device.

device-name: string

Store the name of this device.

description: string

Store the description of this device.

vendor: string

Store the vendor of this device.

class: string

Store the class of this device.

type: string

Store the type of this device.

version: string

Store the version of this device.

system-ip: string

Store the system-ip of this device.

system-ipv4: string

Store the system-ipv4 of this device.

system-ipv6: string

Store the system-ipv6 of this device.

selflink: string

Store the link to get more information for this object.

operational-status: string

Store the operational-status for this object.

model-customization-id: string

Store the model-customization-id for this object.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-dhcp-service: object

Instance of a dhcp-service

  • FROM lan-port-config (PARENT of dhcp-service, lan-port-config Uses dhcp-service, ONE2MANY)

    • For CCVPN Usecase(3)

  • (3) IF this FROM node is deleted, this DHCP-SERVICE is DELETED also
dhcp-service-id: string

Uniquely identifies this dhcp-service by id

server-ipv4-address: string

Store the server-ip4-address of this dhcp-service.

server-ipv6-address: string

Store the server-ipv6-address of this dhcp-service.

service-enable: string

Store the service-enable of this dhcp-service.

dhcp-service-type: string

Store the dhcp-service-type of this dhcp-service.

lease-time: string

Store the lease-time of this dhcp-service.

domain-name: string

Store the domain-name of this dhcp-service.

dns: string

Store the dns of this dhcp-service.

ntp-primary: string

Store the ntp-primary of this dhcp-service.

ntp-secondary: string

Store the ntp-secondary of this dhcp-service.

nbns: string

Store the nbns of this dhcp-service.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-dvs-switch: object

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.

  • TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
  • TO cloud-region (PARENT of dvs-switch, dvs-switch BelongsTo cloud-region, MANY2ONE)
switch-name: string

DVS switch name

vcenter-url: string

URL used to reach the vcenter

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-edge-prop-names: object

Internal map to define the properties of an edge and interpret the map EdgeRules

edgeLabel: string
direction: string
multiplicityRule: string
contains-other-v: string
delete-other-v: string
SVC-INFRA: string
prevent-delete: string
aai-uuid: string

zzzz-patch-edge-tag-query-request: object

edge-tag: string
result-detail: string
start-node-type: string

zzzz-patch-element-choice-set: object

This is how we would capture constraints defining allowed sets of elements.

  • TO constrained-element-set (PARENT of element-choice-set, element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
  • FROM model-element (CHILD of element-choice-set, model-element BelongsTo element-choice-set, MANY2ONE)(1)

  • (1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
element-choice-set-uuid: string
data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

element-choice-set-name: string
cardinality: string
relationship-list: object
relationship

zzzz-patch-endpoint: object

describes an endpoints

  • FROM cloud-region( cloud-region Uses endpoint, MANY2MANY)
  • FROM complex( complex Uses endpoint, MANY2MANY)
  • FROM ip-address-list (CHILD of endpoint, ip-address-list BelongsTo endpoint, MANY2ONE)(1)
  • FROM platform( platform Uses endpoint, ONE2MANY)

    • Used by Auditing applications to identify appropriate audit models based on the platform associated with the given object

  • FROM pnf( pnf Uses endpoint, MANY2MANY)
  • FROM port-list (CHILD of endpoint, port-list BelongsTo endpoint, MANY2ONE)(1)
  • FROM profile( profile AppliesTo endpoint, MANY2MANY)

    • A profile (set of characteristics) applies to the endpoint.

  • FROM pserver( pserver Uses endpoint, MANY2MANY)
  • FROM relationship-rule( relationship-rule AppliesTo endpoint, MANY2MANY)

    • Details relationships endpoint requires

  • FROM selector-list (CHILD of endpoint, selector-list BelongsTo endpoint, MANY2ONE)(1)
  • FROM zone( zone Uses endpoint, MANY2MANY)

  • (1) IF this ENDPOINT node is deleted, this FROM node is DELETED also
endpoint-id: string

Unique identifier for the endpoint.

endpoint-name: string

Name of the endpoint.

endpoint-type: string

Type of the endpoint. Expected values are DNS, ETCD, Kubernetes, etc.

endpoint-name2: string

Alternate name of the endpoint

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-entitlement: object

Metadata for entitlement group.

  • TO generic-vnf (PARENT of entitlement, entitlement BelongsTo generic-vnf, MANY2ONE)(4)
  • TO vce (PARENT of entitlement, entitlement BelongsTo vce, MANY2ONE)(4)

  • (4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
group-uuid: string

Unique ID for the entitlement group the resource comes from, should be uuid.

resource-uuid: string

Unique ID of an entitlement resource.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-esi: object

specifies Ethernet Segment Identifier associated with a lag-interface.

  • TO lag-interface (PARENT of esi, esi BindsTo lag-interface, ONE2ONE)

    • used for generic interface parameters(4)

  • (4) IF this TO node is deleted, this ESI is DELETED also
esi-id: string

object identifier

active-option: string

Values, null, all-active, single-active

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-esr-ems: object

Persist EMS address information used by EMS driver.

  • FROM esr-system-info (CHILD of esr-ems, esr-system-info BelongsTo esr-ems, MANY2ONE)(1)

  • (1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
ems-id: string

Unique ID of EMS.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-esr-nfvo: object

Persist NFVO address information used by VF-C.

  • FROM esr-system-info (CHILD of esr-nfvo, esr-system-info BelongsTo esr-nfvo, ONE2ONE)(1)

  • (1) IF this ESR-NFVO node is deleted, this FROM node is DELETED also
nfvo-id: string

Unique ID of nfvo.

api-root: string

indecate the api-root.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-esr-system-info: object

Persist common address information of external systems.

  • TO cloud-region (PARENT of esr-system-info, esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
  • TO esr-ems (PARENT of esr-system-info, esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
  • TO esr-nfvo (PARENT of esr-system-info, esr-system-info BelongsTo esr-nfvo, ONE2ONE)(4)
  • TO esr-thirdparty-sdnc (PARENT of esr-system-info, esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
  • TO esr-vnfm (PARENT of esr-system-info, esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
  • FROM ext-aai-network (PARENT of esr-system-info, ext-aai-network Uses esr-system-info, ONE2MANY)

    • For CCVPN Usecase(3)

  • (3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also
  • (4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
esr-system-info-id: string

Unique ID of esr system info.

system-name: string

name of external system.

type: string

type of external systems.

vendor: string

vendor of external systems.

version: string

version of external systems.

service-url: string

url used to access external systems.

user-name: string

username used to access external systems.

password: string

password used to access external systems.

system-type: string

it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.

protocol: string

protocol of third party SDNC, for example netconf/snmp.

ssl-cacert: string

ca file content if enabled ssl on auth-url.

ssl-insecure: boolean

Whether to verify VIM's certificate.

ip-address: string

service IP of ftp server.

port: string

service port of ftp server.

cloud-domain: string

domain info for authentication.

default-tenant: string

default tenant of VIM.

passive: boolean

ftp passive mode or not.

remote-path: string

resource or performance data file path.

system-status: string

the status of external system.

openstack-region-id: string

OpenStack region ID used by MultiCloud plugin to interact with an OpenStack instance.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-esr-thirdparty-sdnc: object

Persist SDNC address information used by ONAP SDNC.

  • TO network-resource( esr-thirdparty-sdnc BelongsTo network-resource, ONE2MANY)

    • For MDONS Usecase(2)

  • TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
  • FROM esr-system-info (CHILD of esr-thirdparty-sdnc, esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)

  • (1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
  • (2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also
thirdparty-sdnc-id: string

Unique ID of SDNC.

location: string

used for DC type to indicate the location of SDNC, such as Core or Edge.

product-name: string

password used to access SDNC server.

domain-type: string

Domain type of the SDNC controllerr.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-esr-vnfm: object

Persist VNFM address information used by VF-C.

  • FROM esr-system-info (CHILD of esr-vnfm, esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
  • FROM generic-vnf( generic-vnf DependsOn esr-vnfm, MANY2ONE)

  • (1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
vnfm-id: string

Unique ID of VNFM.

vim-id: string

indecate the VIM to deploy VNF.

certificate-url: string

certificate url of VNFM.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-evc: object

evc object is an optional child object of the Configuration object.

  • TO configuration (PARENT of evc, evc BelongsTo configuration, ONE2ONE)(4)

  • (4) IF this TO node is deleted, this EVC is DELETED also
evc-id: string

Unique/key field for the evc object

forwarding-path-topology: string

Point-to-Point, Multi-Point

cir-value: string

Commited Information Rate

cir-units: string

CIR units

cmtu: integer

Size of the Customer Requested MTU (Maximum Transmission Unit).

connection-diversity-group-id: string

Diversity Group ID

service-hours: string

formerly Performance Group

enhanced-multicast: string

String value indicating whether the EVC uses enhanced multicast. Possible Values:yes/no/[empty string]

esp-evc-circuit-id: string

EVC Circuit ID of ESP EVC

esp-evc-cir-value: string

Committed Information Rate (For ESP)

esp-evc-cir-units: string

CIR units (For ESP)

esp-itu-code: string

Identifies ESP

collector-pop-clli: string

Collector POP CLLI (from the hostname of the access pnf)

inter-connect-type-ingress: string

Interconnect type on ingress side of EVC.

tagmode-access-ingress: string

tagode for collector side of EVC

tagmode-access-egress: string

tagMode for network side of EVC

product-entry-id: string

Product ID

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-ext-aai-network: object

Refer to an external AAI in another ONAP.

  • TO esr-system-info (PARENT of ext-aai-network, ext-aai-network Uses esr-system-info, ONE2MANY)

    • For CCVPN Usecase(2)

  • FROM connectivity( connectivity BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • FROM device( device BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • FROM lan-port-config( lan-port-config BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • FROM logical-link( logical-link BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • FROM network-resource( network-resource BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • FROM pnf( pnf BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • FROM sdwan-vpn( sdwan-vpn BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • FROM site-resource( site-resource BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • FROM vpn-binding( vpn-binding BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • FROM wan-port-config( wan-port-config BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • (2) IF this EXT-AAI-NETWORK node is deleted, this TO node is DELETED also
  • EXT-AAI-NETWORK cannot be deleted if related to CONNECTIVITY,DEVICE,LAN-PORT-CONFIG,LOGICAL-LINK,NETWORK-RESOURCE,PNF,SDWAN-VPN,SITE-RESOURCE,VPN-BINDING,WAN-PORT-CONFIG
aai-id: string

Unique ID of the referenced AAI.

schema-version: string

Schema version of the referenced AAI.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-extra-property: object

property-name: string
property-value: string

zzzz-patch-flavor: object

Openstack flavor.

  • TO cloud-region (PARENT of flavor, flavor BelongsTo cloud-region, MANY2ONE)
  • TO pserver( flavor CanBeInstantiatedIn pserver, MANY2MANY)

    • HPA Capacity getting the compute nodes from given flavor

  • FROM hpa-capability (CHILD of flavor, hpa-capability BelongsTo flavor, MANY2ONE)
  • FROM vserver( vserver Uses flavor, MANY2ONE)

  • FLAVOR cannot be deleted if related to HPA-CAPABILITY,VSERVER
flavor-id: string

Flavor id, expected to be unique across cloud-region.

flavor-name: string

Flavor name

flavor-vcpus: integer

Number of CPUs

flavor-ram: integer

Amount of memory

flavor-disk: integer

Disk space

flavor-ephemeral: integer

Amount of ephemeral disk space

flavor-swap: string

amount of swap space allocation

flavor-is-public: boolean

whether flavor is available to all users or private to the tenant it was created in.

flavor-selflink: string

URL to endpoint where AAI can get more details

flavor-disabled: boolean

Boolean as to whether this flavor is no longer enabled

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-forwarder: object

Entity describing a sequenced segment of forwarding path

  • TO configuration( forwarder Uses configuration, ONE2ONE)(2)
  • TO forwarding-path (PARENT of forwarder, forwarder BelongsTo forwarding-path, MANY2ONE)(4)
  • TO generic-vnf( forwarder AppliesTo generic-vnf, MANY2MANY)

    • Points to the generic-vnf(s) involved in this forwarding step.

  • TO l-interface( forwarder ForwardsTo l-interface, MANY2MANY)
  • TO lag-interface( forwarder ForwardsTo lag-interface, MANY2MANY)
  • TO p-interface( forwarder ForwardsTo p-interface, MANY2MANY)

  • (2) IF this FORWARDER node is deleted, this TO node is DELETED also
  • (4) IF this TO node is deleted, this FORWARDER is DELETED also
sequence: integer

Unique ID of this segmentation

forwarder-role: string

ingress, intermediate, egress

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-forwarder-evc: object

forwarder object is an optional child object of the Configuration object.

  • TO configuration (PARENT of forwarder-evc, forwarder-evc BelongsTo configuration, ONE2ONE)(4)
  • FROM vlan-mapping (CHILD of forwarder-evc, vlan-mapping BelongsTo forwarder-evc, MANY2ONE)(1)

  • (1) IF this FORWARDER-EVC node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
forwarder-evc-id: string

Key for forwarder-evc object

circuit-id: string

Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC

ivlan: string

Internal VLAN.

svlan: string

SVLAN value for ingress of egress forwarder.

cvlan: string

CVLAN value for ingress of egress forwarder.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-forwarding-path: object

Entity that describes the sequenced forwarding path between interfaces of services or resources

  • TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
  • TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
  • FROM forwarder (CHILD of forwarding-path, forwarder BelongsTo forwarding-path, MANY2ONE)(1)

  • (1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
  • (2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
  • (4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
forwarding-path-id: string

Unique ID of this FP

forwarding-path-name: string

Name of the FP

selflink: string

the self link for this FP

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-fqdn: object

A fully qualified domain name (FQDN) is the complete domain name for a specific computer, or host, on the internet.

  • TO fqdn( fqdn AppliesTo fqdn, MANY2MANY)

    • The dns cname record that applies to an A-record (ipv4) and/or quad-A-record (ipv6).

  • TO generic-vnf( fqdn AppliesTo generic-vnf, MANY2ONE)

    • The fqdn that applies to a generic-vnf.

  • TO l3-interface-ipv4-address-list( fqdn AppliesTo l3-interface-ipv4-address-list, ONE2ONE)

    • The fqdn that applies to a l3-interface-ipv4-address-list.

  • TO l3-interface-ipv6-address-list( fqdn AppliesTo l3-interface-ipv6-address-list, ONE2ONE)

    • The fqdn that applies to a l3-interface-ipv6-address-list.

  • TO vip-ipv4-address-list( fqdn AppliesTo vip-ipv4-address-list, ONE2ONE)

    • The fqdn that applies to a vip-ipv4-address-list.

  • TO vip-ipv6-address-list( fqdn AppliesTo vip-ipv6-address-list, ONE2ONE)

    • The fqdn that applies to a vip-ipv6-address-list.

  • FROM fqdn( fqdn AppliesTo fqdn, MANY2MANY)

    • The dns cname record that applies to an A-record (ipv4) and/or quad-A-record (ipv6).

fqdn: string

Fully qualified domain name.

fqdn-type: string

Used to categorize this object in conjunction with role & function. The most generic category.

fqdn-role: string

Used to categorize this object in conjunction with type & function.

fqdn-function: string

Used to categorize this object in conjunction with type & role. The most specific category.

dns-domain: string

Domain name.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-generic-vnf: object

General purpose VNF

  • TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
  • TO bgp-group (PARENT of generic-vnf, generic-vnf BelongsTo bgp-group, MANY2ONE)

    • The bgp-group associated to a generic-vnf.(2)

  • TO bgp-neighbor (PARENT of generic-vnf, generic-vnf BelongsTo bgp-neighbor, MANY2ONE)

    • The bgp-neighbor associated to a generic-vnf.(2)

  • TO cloud-region( generic-vnf LocatedIn cloud-region, MANY2ONE)
  • TO complex( generic-vnf LocatedIn complex, MANY2MANY)
  • TO configuration( generic-vnf Uses configuration, ONE2MANY)(2)
  • TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY)
  • TO esr-vnfm( generic-vnf DependsOn esr-vnfm, MANY2ONE)
  • TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
  • TO instance-group( generic-vnf Uses instance-group, ONE2MANY)
  • TO instance-group( generic-vnf Primary instance-group, ONE2MANY)
  • TO instance-group( generic-vnf Secondary instance-group, ONE2MANY)
  • TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
  • TO k8s-resource( generic-vnf HostedOn k8s-resource, ONE2MANY)
  • TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
  • TO nos-server( generic-vnf HostedOn nos-server, MANY2ONE)
  • TO object-group( generic-vnf AppliesTo object-group, MANY2MANY)

    • A relationship that ties the device to the prefix-list/community-list.

  • TO pnf( generic-vnf HostedOn pnf, MANY2MANY)
  • TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
  • TO tenant( generic-vnf BelongsTo tenant, MANY2ONE)
  • TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
  • TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
  • TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
  • TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
  • FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
  • FROM connectivity( connectivity PartOf generic-vnf, MANY2MANY)

    • For CCVPN Usecase

  • FROM contact( contact supports generic-vnf, MANY2MANY)
  • FROM device( device Uses generic-vnf, ONE2MANY)

    • For CCVPN Usecase

  • FROM entitlement (CHILD of generic-vnf, entitlement BelongsTo generic-vnf, MANY2ONE)(1)
  • FROM forwarder( forwarder AppliesTo generic-vnf, MANY2MANY)

    • Points to the generic-vnf(s) involved in this forwarding step.

  • FROM fqdn( fqdn AppliesTo generic-vnf, MANY2ONE)

    • The fqdn that applies to a generic-vnf.

  • FROM instance-group( instance-group BelongsTo generic-vnf, MANY2ONE)(1)
  • FROM l-interface (CHILD of generic-vnf, l-interface BelongsTo generic-vnf, MANY2ONE)(1)
  • FROM lag-interface (CHILD of generic-vnf, lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
  • FROM lan-port-config( lan-port-config PartOf generic-vnf, MANY2MANY)

    • For CCVPN Usecase

  • FROM license (CHILD of generic-vnf, license BelongsTo generic-vnf, MANY2ONE)(1)
  • FROM line-of-business( line-of-business Uses generic-vnf, MANY2MANY)
  • FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
  • FROM metadatum( metadatum AppliesTo generic-vnf, MANY2MANY)

    • AAI-2154 For BBS Usecase

  • FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
  • FROM platform( platform Uses generic-vnf, MANY2MANY)
  • FROM sdwan-vpn( sdwan-vpn PartOf generic-vnf, MANY2MANY)

    • For CCVPN Usecase

  • FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
  • FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
  • FROM site-resource( site-resource PartOf generic-vnf, MANY2MANY)

    • For CCVPN Usecase

  • FROM uni( uni PartOf generic-vnf, MANY2MANY)

    • For CCVPN Usecase

  • FROM vf-module (CHILD of generic-vnf, vf-module BelongsTo generic-vnf, MANY2ONE)(1)
  • FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
  • FROM wan-port-config( wan-port-config PartOf generic-vnf, MANY2MANY)

    • For CCVPN Usecase

  • (1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
  • (2) IF this GENERIC-VNF node is deleted, this TO node is DELETED also
vnf-id: string

Unique id of VNF. This is unique across the graph.

vnf-instance-id: string

vnf instance id.

vnf-name: string

Name of VNF.

vnf-name2: string

Alternate name of VNF.

vnf-type: string

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

service-id: string

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

regional-resource-zone: string

Regional way of organizing pservers, source of truth should define values

prov-status: string

Trigger for operational monitoring of this resource by Service Assurance systems.

operational-status: string

Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.

license-key: string

OBSOLETE - do not use

equipment-role: string

Client should send valid enumerated value

orchestration-status: string

Orchestration status of this VNF, used by MSO.

vnf-package-name: string
vnf-discriptor-name: string

vnf discriptor name

job-id: string

job id corresponding to vnf

heat-stack-id: string

Heat stack id corresponding to this instance, managed by MSO

mso-catalog-key: string

Corresponds to the SDN-C catalog id used to configure this VCE

management-option: string

identifier of managed customer

ipv4-oam-address: string

Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.

ipv4-loopback0-address: string

v4 Loopback0 address

nm-lan-v6-address: string

v6 Loopback address

management-v6-address: string

v6 management address

vcpu: integer

number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE

vcpu-units: string

units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE

vmemory: integer

number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE

vmemory-units: string

units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE

vdisk: integer

number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE

vdisk-units: string

units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE

nshd: integer

number of associated SHD in vnf.

nvm: integer

number of vms in vnf.

nnet: integer

number of network in vnf.

in-maint: boolean

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.

is-closed-loop-disabled: boolean

used to indicate whether closed loop function is enabled on this node

summary-status: string

details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.

encrypted-access-flag: boolean

indicates whether generic-vnf access uses SSH

entitlement-assignment-group-uuid: string

UUID of the Entitlement group used for licensing VNFs, OBSOLETE - See child relationships.

entitlement-resource-uuid: string

UUID of the specific entitlement resource. OBSOLETE - See child relationships.

license-assignment-group-uuid: string

UUID of the license assignment group. OBSOLETE - See child relationships.

license-key-uuid: string

UUID of the actual license resource. OBSOLETE - See child relationships.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

persona-model-version: string

the ASDC model version for this resource or service model.

model-customization-id: string

captures the id of all the configuration used to customize the resource for the service.

widget-model-id: string

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

widget-model-version: string

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

as-number: string

as-number of the VNF

regional-resource-subzone: string

represents sub zone of the rr plane

nf-type: string

Generic description of the type of NF

nf-function: string

English description of Network function that the specific VNF deployment is providing

nf-role: string

role in the network that this model will be providing

nf-naming-code: string

string assigned to this model used for naming purposes

selflink: string

Path to the controller object.

ipv4-oam-gateway-address: string

Gateway address

ipv4-oam-gateway-address-prefix-length: integer

Prefix length for oam-address

vlan-id-outer: integer

Temporary location for S-TAG to get to VCE

nm-profile-name: string

Network Management profile of this VNF

software-version: string

VNF instance specific software version

application-id: string

vnf application-id

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-geo-region: object

Top level node for a cg-nat geographical region.

  • FROM cloud-region( cloud-region MemberOf geo-region, MANY2MANY)

    • The cloud-region associated to a geo-region

  • FROM complex( complex MemberOf geo-region, MANY2MANY)

    • The complex associated to a geo-region

  • FROM lag-interface( lag-interface MemberOf geo-region, MANY2MANY)

    • The lag-interface associated to a geo-region

geo-region-id: string

UUID, key for geo-region object.

geo-region-name: string

Name of geo-region

geo-region-type: string

Type of geo-region

geo-region-role: string

Role of geo-region

geo-region-function: string

Function of geo-region

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-gig-ether-option: object

specifies any gigabit ethernet options associated with a p-interface.

  • TO p-interface (PARENT of gig-ether-option, gig-ether-option BindsTo p-interface, ONE2ONE)

    • used for generic interface parameters(4)

  • (4) IF this TO node is deleted, this GIG-ETHER-OPTION is DELETED also
gig-ether-option-id: string

UUID - unique object identifier

fec: string

Forward Error Correction Values, null, FEC91, and other future values

lacp-on-bundle-id: string

link aggregation control protocol on bundle id

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-group-assignment: object

Openstack group-assignment used to store exclusivity groups (EG).

  • TO cloud-region (PARENT of group-assignment, group-assignment BelongsTo cloud-region, MANY2ONE)
  • FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
  • FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
group-id: string

Group id, expected to be unique across cloud-region.

group-type: string

Group type - the type of group this instance refers to

group-name: string

Group name - name assigned to the group

group-description: string

Group description - description of the group

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-hardware-catalog-item: object

describes an hardware-catalog-items

  • FROM cable( cable IsA hardware-catalog-item, MANY2ONE)

    • The cable is this item from the hardware-catalog.

  • FROM card( card IsA hardware-catalog-item, MANY2ONE)

    • The card is described by the hardware-catalog-item.

  • FROM chassis( chassis IsA hardware-catalog-item, MANY2ONE)

    • The chassis is described by the hardware-catalog-item.

  • FROM pdu( pdu IsA hardware-catalog-item, MANY2ONE)

    • The pdu is described by the hardware-catalog-item.

  • FROM pluggable( pluggable IsA hardware-catalog-item, MANY2ONE)

    • The pluggable is described by the hardware-catalog-item.

  • FROM profile( profile AppliesTo hardware-catalog-item, MANY2MANY)

    • A set of characteristics of the hardware-catalog-item.

  • FROM rack( rack IsA hardware-catalog-item, MANY2ONE)

    • The rack is this item from the hardware-catalog.

  • HARDWARE-CATALOG-ITEM cannot be deleted if related to CABLE,CARD,CHASSIS,PDU,PLUGGABLE,RACK
item-name: string

Unique name for the hardware-catalog-item

system-type: string

Type of system defined by ATT

manufacturer: string

Manufacturer of the hardware-catalog-item (ex,Cisco)

model: string

Model of the hardware-catalog-item (ex,5501 NCS)

part-number: string

Part number assigned by the manufacturer

description: string

Description of the hardware-catalog-item

sku: string

Stock-keeping-unit (ATT specific identifier for the hardware-catalog-item)

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-hold-timer: object

The hold timer enables interface damping by not advertising interface transitions until the hold timer duration has passed.

  • TO p-interface (PARENT of hold-timer, hold-timer BindsTo p-interface, ONE2ONE)

    • used for generic interface parameters(4)

  • (4) IF this TO node is deleted, this HOLD-TIMER is DELETED also
hold-timer-id: string

UUID - unique object identifier

up: string

hold timer value for interface transition from down to up

down: string

hold timer value for interface transition from up to down

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-host-aggregate: object

describes an hostAggregates

  • TO cloud-region (PARENT of host-aggregate, host-aggregate BelongsTo cloud-region, MANY2ONE)(4)
  • TO pserver( host-aggregate BelongsTo pserver, MANY2ONE)

  • (4) IF this TO node is deleted, this HOST-AGGREGATE is DELETED also
host-aggregate-id: string

Unique identifier for the host-aggregate.

host-aggregate-name: string

Name of the host-aggregate.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-host-route: object

Route packets to a specific host. Host routes are automatically added to the routing table for all IPv4 and IPv6 addresses that are configured on the router. The purpose of a host route is to create a corresponding CEF entry as a receive entry so that the packets destined to this IP address can be processed by the router itself.

  • TO subnet (PARENT of host-route, host-route BelongsTo subnet, MANY2ONE)(4)

  • (4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
host-route-id: string

host-route id

route-prefix: string

subnet prefix

next-hop: string

Could be ip-address, hostname, or service-instance

next-hop-type: string

Should be ip-address, hostname, or service-instance to match next-hop

metric: integer

Value that is assigned to an IP route for a particular network interface that identifies the cost that is associated with using that route.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-hpa-capability: object

Represents a HPA capability

  • TO cloud-region (PARENT of hpa-capability, hpa-capability BelongsTo cloud-region, MANY2ONE)
  • TO flavor (PARENT of hpa-capability, hpa-capability BelongsTo flavor, MANY2ONE)
  • FROM hpa-feature-attributes (CHILD of hpa-capability, hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)

  • (1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
hpa-capability-id: string

UUID to uniquely identify a HPA capability

hpa-feature: string

Name of the HPACapability

hpa-version: string

HPA schema version

architecture: string

Hardware architecture

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-hpa-capacity: object

HPA Capacity information for compute node

  • TO pserver (PARENT of hpa-capacity, hpa-capacity BelongsTo pserver, MANY2ONE)

    • HPA Capacity KV for given compute node(4)

  • (4) IF this TO node is deleted, this HPA-CAPACITY is DELETED also
hpa-capacity-key: string

Composite key formed with hpaFeature and append list of hpaFeatureAttributes needed for capacity check

hpa-capacity-value: string

JSON string specifying the capacity (total,free), unit and metadata of the specific HPA attribute

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-hpa-feature-attributes: object

HPA Capability Feature attributes

  • TO hpa-capability (PARENT of hpa-feature-attributes, hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)

  • (4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
hpa-attribute-key: string

name of the specific HPA attribute

hpa-attribute-value: string

JSON string specifying the value, unit and type of the specific HPA attribute

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-hw-component: object

create/update/delete the hw-component node

  • TO profile( hw-component AppliesTo profile, MANY2MANY)

    • The profile associated to a hw-component

  • FROM pnf( pnf MemberOf hw-component, MANY2ONE)

    • The hw-component associated to a pnf

  • FROM pserver( pserver MemberOf hw-component, MANY2ONE)

    • The hw-component associated to a pserver

hw-component-id: string

UUID

hw-component-name: string

Name of hardware component

hw-component-type: string

Type of hardware component

hw-component-role: string

Role of hardware component

hw-component-function: string

Function of hardware component

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-image: object

Openstack image.

  • TO cloud-region (PARENT of image, image BelongsTo cloud-region, MANY2ONE)
  • FROM metadatum (CHILD of image, metadatum BelongsTo image, MANY2ONE)(1)
  • FROM vserver( vserver Uses image, MANY2ONE)

  • (1) IF this IMAGE node is deleted, this FROM node is DELETED also
  • IMAGE cannot be deleted if related to VSERVER
image-id: string

Image id, expected to be unique across cloud region

image-name: string

Image name

image-architecture: string

Operating system architecture.

image-os-distro: string

The common name of the operating system distribution in lowercase

image-os-version: string

The operating system version as specified by the distributor.

application: string

The application that the image instantiates.

application-vendor: string

The vendor of the application.

application-version: string

The version of the application.

image-selflink: string

URL to endpoint where AAI can get more details

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-include-node-filter: object

include-node-type: string

zzzz-patch-instance-group: object

General mechanism for grouping instances

  • TO collection( instance-group BelongsTo collection, ONE2ONE)
  • TO generic-vnf( instance-group BelongsTo generic-vnf, MANY2ONE)(4)
  • TO instance-group( instance-group AppliesTo instance-group, MANY2MANY)

    • The instance-group associated to an instance-group

  • TO model( instance-group Targets model, MANY2MANY)
  • FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
  • FROM cloud-region( cloud-region Uses instance-group, ONE2MANY)
  • FROM configuration( configuration PartOf instance-group, MANY2ONE)
  • FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
  • FROM generic-vnf( generic-vnf Uses instance-group, ONE2MANY)
  • FROM generic-vnf( generic-vnf Primary instance-group, ONE2MANY)
  • FROM generic-vnf( generic-vnf Secondary instance-group, ONE2MANY)
  • FROM instance-group( instance-group AppliesTo instance-group, MANY2MANY)

    • The instance-group associated to an instance-group

  • FROM l-interface( l-interface MemberOf instance-group, MANY2MANY)
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
  • FROM l3-network( l3-network MemberOf instance-group, MANY2MANY)
  • FROM mapping( mapping Current instance-group, MANY2MANY)
  • FROM mapping( mapping MemberOf instance-group, MANY2MANY)

    • The mapping associated to an instance-group

  • FROM mapping( mapping Target instance-group, MANY2MANY)
  • FROM pnf( pnf MemberOf instance-group, MANY2MANY)
  • FROM pnf( pnf Primary instance-group, MANY2MANY)
  • FROM pnf( pnf Secondary instance-group, MANY2MANY)
  • FROM policy( policy AppliesTo instance-group, MANY2ONE)

    • The policy associated to an instance-group

  • FROM profile( profile AppliesTo instance-group, MANY2MANY)

    • A profile (set of characteristics) applies to the instance-group (as a vrrp group).

  • FROM rack( rack MemberOf instance-group, MANY2ONE)

    • The rack is a member of the instance-group (rack-group or pod).

  • FROM service-instance( service-instance Uses instance-group, ONE2MANY)

    • MSO creates this edge on VNF Group Service creation

  • FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
  • FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
  • FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
  • FROM vnfc( vnfc MemberOf instance-group, MANY2MANY)
  • FROM vrf( vrf Primary instance-group, MANY2MANY)

    • used for vrf fallback

  • FROM vrf( vrf Secondary instance-group, MANY2MANY)

    • used for vrf fallback

  • FROM vserver( vserver MemberOf instance-group, MANY2MANY)

  • (4) IF this TO node is deleted, this INSTANCE-GROUP is DELETED also
  • INSTANCE-GROUP cannot be deleted if related to RACK
id: string

Instance Group ID, UUID assigned to this instance.

instance-group-role: string

role of the instance group.

model-invariant-id: string

ASDC model id for this resource or service model.

model-version-id: string

ASDC model version uid for this resource model.

description: string

Descriptive text to help identify the usage of this instance-group

instance-group-type: string

Only valid value today is lower case ha for high availability

instance-group-name: string

Instance-Group Name.

instance-group-function: string

Instance-Group Function

instance-group-number: integer

Number used to identify an instance-group

priority-number: string

Used to identify the primary and secondary priority

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-interlayer-attachment: object

Instance of an inter layer topology attachment

  • FROM p-interface( p-interface LinksTo interlayer-attachment, MANY2MANY)

    • For CCVPN Usecase(1)

  • FROM tunnel-termination-point( tunnel-termination-point LinksTo interlayer-attachment, MANY2MANY)

    • For CCVPN Usecase(1)

  • (1) IF this INTERLAYER-ATTACHMENT node is deleted, this FROM node is DELETED also
id: string

Id that identifies the interlayer topology attachment

inter-layer-lockId: integer

Inter layer lock id

selflink: string

Store the link to get more information for this object.

model-customization-id: string

Store the model-customization-id for this object.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-inventory-item: object

inventory-item-type: string
inventory-item-link: string

zzzz-patch-inventory-item-data: object

property-name: string
property-value: string

zzzz-patch-inventory-response-item: object

Inventory item for response list

model-name: string

zzzz-patch-ip-address-list: object

IP Address Range

  • TO endpoint (PARENT of ip-address-list, ip-address-list BelongsTo endpoint, MANY2ONE)(4)
  • TO l3-interface-ipv4-address-list( ip-address-list Uses l3-interface-ipv4-address-list, ONE2ONE)

    • 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

  • TO l3-interface-ipv6-address-list( ip-address-list Uses l3-interface-ipv6-address-list, ONE2ONE)

    • 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

  • TO object-group (PARENT of ip-address-list, ip-address-list BelongsTo object-group, MANY2ONE)(4)
  • TO policy (PARENT of ip-address-list, ip-address-list BelongsTo policy, MANY2ONE)

    • An ip-address-list BelongsTo a policy.(4)

  • TO port-list( ip-address-list BelongsTo port-list, MANY2MANY)
  • TO rule (PARENT of ip-address-list, ip-address-list BelongsTo rule, MANY2ONE)(4)
  • TO subnet (PARENT of ip-address-list, ip-address-list BelongsTo subnet, MANY2ONE)(4)
  • TO vip-ipv4-address-list( ip-address-list Uses vip-ipv4-address-list, ONE2ONE)

    • 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

  • TO vip-ipv6-address-list( ip-address-list Uses vip-ipv6-address-list, ONE2ONE)

    • 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

  • (4) IF this TO node is deleted, this IP-ADDRESS-LIST is DELETED also
ip-address: string

IP address

ip-address-end: string

IP address end range

ip-version: string

ip version, either 4 or 6

type: string

reserved, static, dhcp

assignment: string
operator: string

Operator to apply to the port (greater than, less than, etc).

length: integer

ip-address prefix length, 32 for single address.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-ipsec-configuration: object

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

  • FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
  • FROM vig-server (CHILD of ipsec-configuration, vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)

  • (1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
ipsec-configuration-id: string

UUID of this configuration

requested-vig-address-type: string

Indicate the type of VIG server like AVPN, INTERNET, BOTH

requested-encryption-strength: string

Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc

requested-dmz-type: string

Shared DMZ or a DMZ specific to a customer

shared-dmz-network-address: string

Network address of shared DMZ

requested-customer-name: string

If the DMZ is a custom DMZ, this field will indicate the customer information

ike-version: string

can be 1 or 2

ikev1-authentication: string

Contains values like md5, sha1, sha256, sha384

ikev1-encryption: string

Encyption values like 3des-cbc, des-cbc, aes-128-cbc,aes-192-cbc, aes-265-cbc

ikev1-dh-group: string

Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14

ikev1-am-group-id: string

Group name defined in VIG for clients using aggressive mode

ikev1-am-password: string

pre-shared key for the above group name

ikev1-sa-lifetime: string

Lifetime for IKEv1 SA

ipsec-authentication: string

md5, sha1, sha256, sha384

ipsec-encryption: string

3des-cbc, des-cbc, aes-128-cbc,aes-192-cbc, aes-265-cbc

ipsec-sa-lifetime: string

Life time for IPSec SA

ipsec-pfs: string

enable PFS or not

xauth-userid: string

user ID for xAuth, sm-user,ucpeHostName,nmteHostName

xauth-user-password: string

Encrypted using the Juniper $9$ algorithm

dpd-interval: string

The time between DPD probe

dpd-frequency: string

Maximum number of DPD before claiming the tunnel is down

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-k8s-resource: object

General purpose kubernetes resource.

  • TO tenant (PARENT of k8s-resource, k8s-resource BelongsTo tenant, MANY2ONE)
  • FROM generic-vnf( generic-vnf HostedOn k8s-resource, ONE2MANY)
  • FROM vf-module( vf-module Uses k8s-resource, ONE2MANY)
id: string

Unique id of k8s resource. This is unique across the graph.

name: string

Name of the kubernetes resource.

group: string

Kubernetes resource group.

version: string

Resource version.

kind: string

Resource kind as defined by kubernetes e.g. pod, service, etc.

namespace: string

Namespace in which resource is placed.

labels: string

Kubernetes resource labels.

selflink: string

Query towards SO CNF adapter to retrieve full resource data.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-key-data: object

key-name: string
key-value: string

zzzz-patch-l-interface: object

Logical interfaces, e.g., a vnic.

  • TO cp( l-interface LinksTo cp, ONE2ONE)
  • TO generic-vnf (PARENT of l-interface, l-interface BelongsTo generic-vnf, MANY2ONE)(4)
  • TO instance-group( l-interface MemberOf instance-group, MANY2MANY)
  • TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
  • TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
  • TO newvce (PARENT of l-interface, l-interface BelongsTo newvce, MANY2ONE)(4)
  • TO next-hop( l-interface Uses next-hop, ONE2MANY)

    • The l-interface that is used by the next-hop.

  • TO object-group( l-interface MemberOf object-group, ONE2MANY)

    • Member of l-interface

  • TO p-interface (PARENT of l-interface, l-interface BindsTo p-interface, MANY2ONE)(4)
  • TO pnf (PARENT of l-interface, l-interface BelongsTo pnf, MANY2ONE)

    • A logical interface associated with a pnf.(4)

  • TO pserver (PARENT of l-interface, l-interface BelongsTo pserver, MANY2ONE)

    • A logical interface associated with a pserver.(4)

  • TO vlan-tag( l-interface Uses vlan-tag, MANY2MANY)

    • An sub-interface that uses a vlan-tag.

  • TO vserver (PARENT of l-interface, l-interface BindsTo vserver, MANY2ONE)(4)
  • TO lag-interface (PARENT of l-interface, l-interface BelongsTo lag-interface, MANY2ONE)(4)
  • FROM allotted-resource( allotted-resource Uses l-interface, ONE2MANY)
  • FROM configuration( configuration AppliesTo l-interface, MANY2MANY)
  • FROM forwarder( forwarder ForwardsTo l-interface, MANY2MANY)
  • FROM l-interface (PARENT of l-interface, l-interface BelongsTo l-interface, MANY2ONE)(4)
  • FROM logical-link( logical-link Source l-interface, MANY2MANY)(1)
  • FROM logical-link( logical-link Destination l-interface, MANY2MANY)(1)
  • FROM policy( policy AppliesTo l-interface, MANY2MANY)

    • The policy applies to an l-interface.

  • FROM profile( profile AppliesTo l-interface, MANY2MANY)

    • A profile (set of characteristics) applies to the l-interface.

  • FROM sriov-vf (CHILD of l-interface, sriov-vf BelongsTo l-interface, ONE2ONE)(1)
  • FROM temporary-parameter-list (CHILD of l-interface, temporary-parameter-list BindsTo l-interface, MANY2ONE)

    • used for generic interface parameters(1)

  • FROM vlan (CHILD of l-interface, vlan LinksTo l-interface, MANY2ONE)(1)
  • FROM vrf( vrf Uses l-interface, ONE2MANY)
  • FROM l3-interface-ipv4-address-list (CHILD of l-interface, l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
  • FROM l3-interface-ipv6-address-list (CHILD of l-interface, l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
  • FROM lag-interface( lag-interface Uses l-interface, MANY2MANY)
  • FROM lcmp-unreachable (CHILD of l-interface, lcmp-unreachable BindsTo l-interface, ONE2ONE)

    • used for generic interface(1)

  • (1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
  • (2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
  • (4) IF this TO node is deleted, this L-INTERFACE is DELETED also
interface-name: string

Name given to the interface

interface-role: string

E.g., CUSTOMER, UPLINK, etc.

v6-wan-link-ip: string

Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.

selflink: string

URL to endpoint where AAI can get more details

interface-id: string

ID of interface

macaddr: string

MAC address for the interface

network-name: string

Name of the network

management-option: string

Whether A&AI should be managing this interface of not. Could have value like CUSTOMER

interface-description: string

Human friendly text regarding this interface.

interface-type: string

type to sub-classify the l-interface (ex, loopback)

is-port-mirrored: boolean

boolean indicatating whether or not port is a mirrored.

in-maint: boolean

used to indicate whether or not this object is in maintenance mode (maintenance mode = true)

prov-status: string

Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].

is-ip-unnumbered: boolean

Flag indicating the interface uses the IP Unnumbered configuration.

allowed-address-pairs: string

Freeform field for storing an ip address, list of ip addresses or a subnet block.

priority: integer

Priority used for fail-over. Valid values 1-1024, with 1 being the highest priority.

ops-note: string

Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.

interface-function: string

The function performed by this Linterface

l2-multicasting: boolean

Identifies l2-multicasting support on an l-interface. true indicates that l2-multicasting is supported; defaulted to false .

vlan-id-statement-needed: string

indicates whether the vlan-id-statement needs to be configured for the interface.

encapsulation: string

specifies the encapsulation type

transport-type: string

specifies the transport type, e.g. L2transport

encapsulation-tag-rewrite: string

used to store the re-write command, e.g.rewrite ingress tag pop 1 symmetric

mtu: string

Maximum transmission unit (MTU) is used to determine the maximum size of each packet in any TCP or IP transmission.

load-interval: string

Length of time for which data is used to compute load statistics.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

admin-status: string

Administrative status of the interface. Valid values are 'up', 'down', or 'testing'.

relationship-list: object
relationship

zzzz-patch-l3-interface-ipv4-address-list: object

IPv4 Address Range

  • TO cp (PARENT of l3-interface-ipv4-address-list, l3-interface-ipv4-address-list BelongsTo cp, MANY2ONE)(4)
  • TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
  • TO l-interface (PARENT of l3-interface-ipv4-address-list, l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
  • TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
  • TO lag-interface (PARENT of l3-interface-ipv4-address-list, l3-interface-ipv4-address-list BelongsTo lag-interface, MANY2ONE)

    • A IPv4 address associated with a lag-interface.(4)

  • TO p-interface (PARENT of l3-interface-ipv4-address-list, l3-interface-ipv4-address-list BelongsTo p-interface, MANY2ONE)

    • A IPv4 address associated with a p-interface.(4)

  • TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
  • TO vlan (PARENT of l3-interface-ipv4-address-list, l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
  • TO vnfc (PARENT of l3-interface-ipv4-address-list, l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(4)
  • FROM bgp-group( bgp-group Destination l3-interface-ipv4-address-list, MANY2ONE)

    • To node-type is destination of bgp-group.

  • FROM bgp-group( bgp-group Source l3-interface-ipv4-address-list, MANY2ONE)

    • To node-type is source of bgp-group.

  • FROM bgp-neighbor( bgp-neighbor Uses l3-interface-ipv4-address-list, MANY2ONE)

    • bgp-neighbor uses To node-type.

  • FROM fqdn( fqdn AppliesTo l3-interface-ipv4-address-list, ONE2ONE)

    • The fqdn that applies to a l3-interface-ipv4-address-list.

  • FROM ip-address-list( ip-address-list Uses l3-interface-ipv4-address-list, ONE2ONE)

    • 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

  • (4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
  • L3-INTERFACE-IPV4-ADDRESS-LIST cannot be deleted if related to BGP-GROUP,BGP-NEIGHBOR,IP-ADDRESS-LIST
l3-interface-ipv4-address: string

IP address

l3-interface-ipv4-prefix-length: integer

Prefix length, 32 for single address

vlan-id-inner: integer

Inner VLAN tag

vlan-id-outer: integer

Outer VLAN tag

is-floating: boolean

Indicator of fixed or floating address

neutron-network-id: string

Neutron network id of the interface that address belongs to

neutron-subnet-id: string

Neutron id of subnet that address belongs to

ops-note: string

Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-l3-interface-ipv6-address-list: object

IPv6 Address Range

  • TO cp (PARENT of l3-interface-ipv6-address-list, l3-interface-ipv6-address-list BelongsTo cp, MANY2ONE)(4)
  • TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
  • TO l-interface (PARENT of l3-interface-ipv6-address-list, l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
  • TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
  • TO lag-interface (PARENT of l3-interface-ipv6-address-list, l3-interface-ipv6-address-list BelongsTo lag-interface, MANY2ONE)

    • A IPv6 address associated with a lag-interface.(4)

  • TO p-interface (PARENT of l3-interface-ipv6-address-list, l3-interface-ipv6-address-list BelongsTo p-interface, MANY2ONE)

    • A IPv6 address associated with a p-interface.(4)

  • TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
  • TO vlan (PARENT of l3-interface-ipv6-address-list, l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
  • TO vnfc (PARENT of l3-interface-ipv6-address-list, l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(4)
  • FROM bgp-group( bgp-group Destination l3-interface-ipv6-address-list, MANY2ONE)

    • To node-type is destination of bgp-group.

  • FROM bgp-group( bgp-group Source l3-interface-ipv6-address-list, MANY2ONE)

    • To node-type is source of bgp-group.

  • FROM bgp-neighbor( bgp-neighbor Uses l3-interface-ipv6-address-list, MANY2ONE)

    • bgp-neighbor uses To node-type.

  • FROM fqdn( fqdn AppliesTo l3-interface-ipv6-address-list, ONE2ONE)

    • The fqdn that applies to a l3-interface-ipv6-address-list.

  • FROM ip-address-list( ip-address-list Uses l3-interface-ipv6-address-list, ONE2ONE)

    • 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

  • (4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
  • L3-INTERFACE-IPV6-ADDRESS-LIST cannot be deleted if related to BGP-GROUP,BGP-NEIGHBOR,IP-ADDRESS-LIST
l3-interface-ipv6-address: string

IP address

l3-interface-ipv6-prefix-length: integer

Prefix length, 128 for single address

vlan-id-inner: integer

Inner VLAN tag

vlan-id-outer: integer

Outer VLAN tag

is-floating: boolean

Indicator of fixed or floating address

neutron-network-id: string

Neutron network id of the interface that address belongs to

neutron-subnet-id: string

Neutron id of subnet that address belongs to

ops-note: string

Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-l3-network: object

Generic network definition

  • TO cp( l3-network LinksTo cp, MANY2MANY)
  • TO instance-group( l3-network MemberOf instance-group, MANY2MANY)
  • TO l3-network( l3-network Uses l3-network, MANY2MANY)

    • l3-network uses l3-network

  • TO network-policy( l3-network Uses network-policy, MANY2MANY)
  • TO network-route( l3-network Uses network-route, MANY2MANY)

    • Relates l3-network to network-route for static routes.

  • TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
  • TO vlan-tag( l3-network Uses vlan-tag, MANY2MANY)

    • A l3-network Uses vlan-tag.

  • TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
  • FROM aggregate-route (CHILD of l3-network, aggregate-route BelongsTo l3-network, MANY2ONE)(1)
  • FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
  • FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
  • FROM complex( complex Uses l3-network, MANY2MANY)
  • FROM configuration( configuration PartOf l3-network, MANY2MANY)
  • FROM ctag-assignment (CHILD of l3-network, ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
  • FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
  • FROM l3-network( l3-network Uses l3-network, MANY2MANY)

    • l3-network uses l3-network

  • FROM line-of-business( line-of-business Uses l3-network, MANY2MANY)
  • FROM platform( platform Uses l3-network, MANY2MANY)
  • FROM policy( policy AppliesTo l3-network, MANY2MANY)

    • A policy applies to l3-networks.

  • FROM profile( profile AppliesTo l3-network, MANY2MANY)

    • A profile (set of characteristics) applies to the l3-network.

  • FROM segmentation-assignment (CHILD of l3-network, segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
  • FROM service-instance( service-instance ComposedOf l3-network, MANY2MANY)
  • FROM subnet (CHILD of l3-network, subnet BelongsTo l3-network, MANY2ONE)(1)
  • FROM tenant( tenant Uses l3-network, MANY2MANY)
  • FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
  • FROM vrf( vrf Uses l3-network, ONE2MANY)

    • A vrf uses many l3-networks

  • (1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
  • L3-NETWORK cannot be deleted if related to NETWORK-ROUTE
network-id: string

Network ID, should be uuid. Unique across A&AI.

network-name: string

Name of the network, governed by some naming convention..

network-type: string

Type of the network - who defines these values?

network-role: string

Role the network plans - who defines these values?

network-technology: string

Network technology - who defines these values?

description: string

text used for documentation

neutron-network-id: string

Neutron network id of this Interface

is-bound-to-vpn: boolean

Set to true if bound to VPN

service-id: string

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

network-role-instance: integer

network role instance

orchestration-status: string

Orchestration status of this VNF, mastered by MSO

heat-stack-id: string

Heat stack id corresponding to this instance, managed by MSO

mso-catalog-key: string

Corresponds to the SDN-C catalog id used to configure this VCE

contrail-network-fqdn: string

Contrail FQDN for the network

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

persona-model-version: string

the ASDC model version for this resource or service model.

model-customization-id: string

captures the id of all the configuration used to customize the resource for the service.

widget-model-id: string

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

widget-model-version: string

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

physical-network-name: string

Name associated with the physical network.

is-provider-network: boolean

boolean indicatating whether or not network is a provider network.

is-shared-network: boolean

boolean indicatating whether or not network is a shared network.

is-external-network: boolean

boolean indicatating whether or not network is an external network.

selflink: string

Path to the controller object.

operational-status: string

Indicator for whether the resource is considered operational.

is-trunked: boolean

Trunked network indication.

ops-note: string

Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.

network-function: string

The function performed by this l3 network

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-label-restriction: object

Instance of an label restriction

  • TO te-link-attribute( label-restriction LinksTo te-link-attribute, MANY2MANY)

    • For CCVPN Usecase(4)

  • (4) IF this TO node is deleted, this LABEL-RESTRICTION is DELETED also
id: string

Id that identifies the label restriction

label-start: integer

First number in the label range

label-end: integer

Last number in the label range

range-bitmap: string

Bitmap of available labels starting from label-start to label-end.

label-step: integer

Step of labels in label range.

inclusive-exclusive: string

Indicate wheather range-bitmap items are inclusive or exclusive.

range-type: string

Indicate the label range e.g.trib-slot, trib-port

trib-slot-granularity: string

Indicate trib slot granularity.

priority: integer

Priority.

selflink: string

Store the link to get more information for this object.

operational-status: string

Store the operational-status for this object.

model-customization-id: string

Store the model-customization-id for this object.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-lacp: object

Used to specify Link Aggregation Control Protocol attributes.

  • TO aggregated-ether-option (PARENT of lacp, lacp BindsTo aggregated-ether-option, ONE2ONE)

    • used for generic interface parameters(4)

  • (4) IF this TO node is deleted, this LACP is DELETED also
lacp-id: string

UUID- unique object identifier

system-id: string

LACP system identifier at the aggregated Ethernet interface level

mode: string

specifies the state of the interface

periodic: string

periodic transmission rate

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-lag-interface: object

Link aggregate interface

  • TO generic-vnf (PARENT of lag-interface, lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
  • TO geo-region( lag-interface MemberOf geo-region, MANY2MANY)

    • The lag-interface associated to a geo-region

  • TO l-interface( lag-interface Uses l-interface, MANY2MANY)
  • TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
  • TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2)
  • TO p-interface( lag-interface Uses p-interface, MANY2MANY)
  • TO pnf (PARENT of lag-interface, lag-interface BindsTo pnf, MANY2ONE)(4)
  • TO pserver (PARENT of lag-interface, lag-interface BindsTo pserver, MANY2ONE)(4)
  • TO vpls-pe (PARENT of lag-interface, lag-interface BindsTo vpls-pe, MANY2ONE)(4)
  • FROM aggregated-ether-option (CHILD of lag-interface, aggregated-ether-option BindsTo lag-interface, ONE2ONE)

    • used for generic interface parameters(1)

  • FROM configuration( configuration AppliesTo lag-interface, MANY2ONE)
  • FROM esi (CHILD of lag-interface, esi BindsTo lag-interface, ONE2ONE)

    • used for generic interface parameters(1)

  • FROM forwarder( forwarder ForwardsTo lag-interface, MANY2MANY)
  • FROM l3-interface-ipv4-address-list (CHILD of lag-interface, l3-interface-ipv4-address-list BelongsTo lag-interface, MANY2ONE)

    • A IPv4 address associated with a lag-interface.(1)

  • FROM l3-interface-ipv6-address-list (CHILD of lag-interface, l3-interface-ipv6-address-list BelongsTo lag-interface, MANY2ONE)

    • A IPv6 address associated with a lag-interface.(1)

  • FROM l-interface (CHILD of lag-interface, l-interface BelongsTo lag-interface, MANY2ONE)(1)
  • FROM policy( policy AppliesTo lag-interface, MANY2MANY)

    • used to support NCX-Hub

  • FROM profile( profile AppliesTo lag-interface, MANY2MANY)

    • A profile (set of characteristics) applies to the lag-interface.

  • FROM temporary-parameter-list (CHILD of lag-interface, temporary-parameter-list BindsTo lag-interface, MANY2ONE)

    • used for generic interface parameters(1)

  • (1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
  • (2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
  • (4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
interface-name: string

Name that identifies the link aggregate interface

interface-description: string

Human friendly text regarding this interface.

speed-value: string

Captures the numeric part of the speed

speed-units: string

Captures the units corresponding to the speed

interface-id: string

ID of interface

interface-role: string

Role assigned to this Interface, should use values as defined in ONAP Yang models.

prov-status: string

Trigger for operational monitoring of this resource by Service Assurance systems.

in-maint: boolean

used to indicate whether or not this object is in maintenance mode (maintenance mode = true)

lacp-system-id: string

The system id used by the LACP protocol.

ops-note: string

Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.

interface-function: string

The function performed by this Lag interface

min-links: integer

Minimum links in service before a LAG should be taken out of service

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

interface-type: string

Used to identify the type of lag-interface.

encapsulation: string

specifies the encapsulation type

flexible-vlan-tagging: string

Specifies support for simultaneous transmission of 802.1Q VLAN single-tag and dual-tag frames on logical interfaces on the same Ethernet port, and on pseudowire logical interfaces.

mtu: string

Maximum transmission unit (MTU) is used to determine the maximum size of each packet in any TCP or IP transmission.

load-interval: string

Length of time for which data is used to compute load statistics.

logging-event: string

Enables system logging of interface state-change events Values, * NULL (not enabled/configured) Link-status future options, i.e. default, enable, trunk-status.

dampening: string

throttles interface flapping events to prevent excessive churn and processing of routing tables. Values, NULL (dampening not configured DEFAULT (dampening w/o options) configures as dampening dampening options configures dampening w/ options

relationship-list: object
relationship

zzzz-patch-lan-port-config: object

Instance of a lan-port-config

  • TO dhcp-service (PARENT of lan-port-config, lan-port-config Uses dhcp-service, ONE2MANY)

    • For CCVPN Usecase(2)

  • TO ext-aai-network( lan-port-config BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • TO generic-vnf( lan-port-config PartOf generic-vnf, MANY2MANY)

    • For CCVPN Usecase

  • TO service-instance( lan-port-config PartOf service-instance, ONE2MANY)

    • For CCVPN Usecase

  • (2) IF this LAN-PORT-CONFIG node is deleted, this TO node is DELETED also
lan-port-config-id: string

Uniquely identifies this lan-port-config by id

lan-port-config-name: string

Store the name of this lan-port-config.

description: string

Store the description of this lan-port-config.

device-id: string

Store the device-id of this lan-port-config.

port-id: string

Store the port-id of this lan-port-config.

ipv4-address: string

Store the ipv4-address of this lan-port-config.

ipv6-address: string

Store the ipv6-address of this lan-port-config.

vlan-tag: string

Store the vlan-tag of this lan-port-config.

input-bandwidth: string

Store the input-bandwidth of this lan-port-config.

output-bandwidth: string

Store the output-bandwidth of this lan-port-config.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-lcmp-unreachable: object

Flag to indicate generation of Internet Control Message Protocol (ICMP) unreachable messages

  • TO l-interface (PARENT of lcmp-unreachable, lcmp-unreachable BindsTo l-interface, ONE2ONE)

    • used for generic interface(4)

  • (4) IF this TO node is deleted, this LCMP-UNREACHABLE is DELETED also
lcmp-unreachable-id: string

object identifier

af-ipv4: string

Flag to indicate generation of Internet Control Message Protocol (ICMP) unreachable messages for ipv4 address family Values, null, disable, enable

af-ipv6: string

Flag to indicate generation of Internet Control Message Protocol (ICMP) unreachable messages for ipv6 address family Values, null, disable, enable

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-license: object

Metadata for license group.

  • TO chassis (PARENT of license, license BelongsTo chassis, MANY2ONE)

    • A license belongs to a chassis.(4)

  • TO generic-vnf (PARENT of license, license BelongsTo generic-vnf, MANY2ONE)(4)
  • TO vce (PARENT of license, license BelongsTo vce, MANY2ONE)(4)

  • (4) IF this TO node is deleted, this LICENSE is DELETED also
group-uuid: string

Unique ID for the license group the resource belongs to, should be uuid.

resource-uuid: string

Unique ID of a license resource.

project-number: string

Used to store CFAS or other project numbers.

order-number: string

Order number.

receipt-date: string

Date of receipt.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-line-of-business: object

describes a line-of-business

  • TO cloud-region( line-of-business Uses cloud-region, MANY2MANY)
  • TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
  • TO l3-network( line-of-business Uses l3-network, MANY2MANY)
  • TO tenant( line-of-business Uses tenant, MANY2MANY)
  • TO vlan-range( line-of-business Uses vlan-range, ONE2MANY)

    • A line-of uses a vlan-range

  • FROM validation-audit( validation-audit AppliesTo line-of-business, MANY2ONE)

    • The line-of-business associated to a validation-audit

line-of-business-name: string

Name of the line-of-business (product)

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-mapping: object

General mechanism for mapping between instances; cg-nat.

  • TO cloud-region( mapping LocatedIn cloud-region, MANY2MANY)

    • The mapping associated to a cloud-region

  • TO instance-group( mapping Current instance-group, MANY2MANY)
  • TO instance-group( mapping MemberOf instance-group, MANY2MANY)

    • The mapping associated to an instance-group

  • TO instance-group( mapping Target instance-group, MANY2MANY)
  • TO mapping( mapping AppliesTo mapping, MANY2MANY)

    • The mapping associated to a mapping

  • TO mapping( mapping MemberOf mapping, MANY2MANY)

    • The mapping associated to a mapping

  • TO object-group( mapping MemberOf object-group, ONE2MANY)

    • The mapping associated to an object-group

  • TO pnf( mapping MemberOf pnf, ONE2MANY)

    • The mapping associated to a pnf

  • TO policy( mapping MemberOf policy, ONE2MANY)

    • The mapping associated to a policy

  • FROM activity( activity AppliesTo mapping, MANY2MANY)

    • The reservation information associated with a NAT Pool mapping.

  • FROM mapping( mapping AppliesTo mapping, MANY2MANY)

    • The mapping associated to a mapping

  • FROM mapping( mapping MemberOf mapping, MANY2MANY)

    • The mapping associated to a mapping

mapping-id: string

Key for mapping object.

mapping-name: string

Name of mapping

mapping-type: string

Type of mapping.

mapping-role: string

Role of mapping

mapping-function: string

Function of mapping

mapping-number: string

Number of mapping

location-1: string

Location 1

location-2: string

Location 2

mapping-group-id: string

Non-unique ID for grouping mappings

prov-status: string

Provision status for the mapping object. Valid values [PREPROV/NVTPROV/PROV].

homed-location: string

Location the object is homed to

planned-location: string

Location the object is planned for

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-metadatum: object

Key/value pairs

  • TO configuration (PARENT of metadatum, metadatum BelongsTo configuration, MANY2ONE)(4)
  • TO connector (PARENT of metadatum, metadatum BelongsTo connector, MANY2ONE)(4)
  • TO cp( metadatum AppliesTo cp, MANY2MANY)

    • AAI-2154 For BBS Usecase

  • TO generic-vnf( metadatum AppliesTo generic-vnf, MANY2MANY)

    • AAI-2154 For BBS Usecase

  • TO image (PARENT of metadatum, metadatum BelongsTo image, MANY2ONE)(4)
  • TO model-ver (PARENT of metadatum, metadatum BelongsTo model-ver, MANY2ONE)(4)
  • TO pnf( metadatum AppliesTo pnf, MANY2MANY)

    • AAI-2154 For BBS Usecase

  • TO profile (PARENT of metadatum, metadatum BelongsTo profile, MANY2ONE)(4)
  • TO rule (PARENT of metadatum, metadatum BelongsTo rule, MANY2ONE)(4)
  • TO service-instance (PARENT of metadatum, metadatum BelongsTo service-instance, MANY2ONE)(4)

  • (4) IF this TO node is deleted, this METADATUM is DELETED also
metaname: string
metaval: string
data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

zzzz-patch-model: object

Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version

  • FROM instance-group( instance-group Targets model, MANY2MANY)
  • FROM model-ver (CHILD of model, model-ver BelongsTo model, MANY2ONE)(1)
  • FROM named-query( named-query AppliesTo model, ONE2MANY)
  • FROM named-query-element( named-query-element IsA model, MANY2ONE)

  • (1) IF this MODEL node is deleted, this FROM node is DELETED also
  • MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
model-invariant-id: string

Unique identifier corresponding to the main definition of a model in ASDC

model-type: string

Type of the model, e.g., service, resource, widget, etc.

model-role: string

Role of the model,e.g.,NST,NSST,CST,etc

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-model-constraint: object

This is how we would capture constraints defining allowed sets of elements.

  • TO model-element (PARENT of model-constraint, model-constraint BelongsTo model-element, MANY2ONE)(4)
  • FROM constrained-element-set (CHILD of model-constraint, constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)

  • (1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
model-constraint-uuid: string
data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

constrained-element-set-uuid-to-replace: string

zzzz-patch-model-element: object

Defines how other models combine to make up a higher-level model.

  • TO element-choice-set (PARENT of model-element, model-element BelongsTo element-choice-set, MANY2ONE)(4)
  • TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
  • TO model-ver( model-element IsA model-ver, MANY2ONE)
  • TO model-ver (PARENT of model-element, model-element BelongsTo model-ver, MANY2ONE)(4)
  • FROM constrained-element-set (CHILD of model-element, constrained-element-set BelongsTo model-element, MANY2ONE)(1)
  • FROM model-constraint (CHILD of model-element, model-constraint BelongsTo model-element, MANY2ONE)(1)
  • FROM model-element (PARENT of model-element, model-element BelongsTo model-element, MANY2ONE)(4)

  • (1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
model-element-uuid: string
new-data-del-flag: string

Indicates whether this element was created as part of instantiation from this model

cardinality: string

How many of this type of element are required/allowed

linkage-points: string
data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-model-ver: object

Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models

  • TO model (PARENT of model-ver, model-ver BelongsTo model, MANY2ONE)(4)
  • FROM metadatum (CHILD of model-ver, metadatum BelongsTo model-ver, MANY2ONE)(1)
  • FROM model-element( model-element IsA model-ver, MANY2ONE)
  • FROM model-element (CHILD of model-ver, model-element BelongsTo model-ver, MANY2ONE)(1)

  • (1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this MODEL-VER is DELETED also
  • MODEL-VER cannot be deleted if related to MODEL-ELEMENT
model-version-id: string

Unique identifier corresponding to one version of a model in ASDC

model-name: string

Name of the model, which can change from version to version.

model-version: string

Version

distribution-status: string

Distribution Status

model-description: string

Description

sdnc-model-name: string

The CDS blue print name associated with the resource.

sdnc-model-version: string

The version of the CDS blue print.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-multicast-configuration: object

Groups different VLANs that are on different logical interfaces on the same VNF. Multicast is the delivery of information to a group of destinations simultaneously, using the most efficient strategy to deliver messages over each link of the network only once, and create copies only when the links to the destinations split.

  • FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
multicast-configuration-id: string

Unique id of multicast configuration.

multicast-protocol: string

protocol of multicast configuration

rp-type: string

rp type of multicast configuration

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-named-query: object

TBD

  • TO model( named-query AppliesTo model, ONE2MANY)
  • FROM named-query-element (CHILD of named-query, named-query-element BelongsTo named-query, ONE2ONE)(1)

  • (1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
named-query-uuid: string
named-query-name: string
named-query-version: string
required-input-param: string
description: string
relationship-list: object
relationship

zzzz-patch-named-query-element: object

TBD

  • TO model( named-query-element IsA model, MANY2ONE)
  • TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
  • TO named-query (PARENT of named-query-element, named-query-element BelongsTo named-query, ONE2ONE)(4)
  • FROM named-query-element (PARENT of named-query-element, named-query-element BelongsTo named-query-element, MANY2ONE)(4)
  • FROM property-constraint (CHILD of named-query-element, property-constraint BelongsTo named-query-element, MANY2ONE)(1)
  • FROM related-lookup (CHILD of named-query-element, related-lookup BelongsTo named-query-element, MANY2ONE)(1)

  • (1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
named-query-element-uuid: string
property-collect-list: string
property-limit-desc: string
do-not-output: string
relationship-list: object
relationship

zzzz-patch-network-policy: object

Captures set of conditions, constraints, and settings that allow designation of who is authorized to connect to the network and the circumstances under which they can or cannot connect. Provides Contrail FQDN for policy.

  • FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE)
  • FROM l3-network( l3-network Uses network-policy, MANY2MANY)
network-policy-id: string

UUID representing unique key to this instance

network-policy-fqdn: string

Contrail FQDN for the policy

heat-stack-id: string

ID for the openStack Heat instance

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

name: string

Name of the policy

type: string

Type of the policy

latency: integer

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: integer

jitter

max-bandwidth: integer

The maximum bandwidth (mb) of the connection links in a transport slice instance.

relationship-list: object
relationship

zzzz-patch-network-profile: object

Network profile populated by SDN-GP for SNMP

  • TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
nm-profile-name: string

Unique name of network profile.

community-string: string

Encrypted SNMP community string

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-network-range: object

Description of Network Range

  • TO cloud-region( network-range LocatedIn cloud-region, MANY2MANY)

    • The network-range is located in a cloud-region

  • TO complex( network-range LocatedIn complex, MANY2MANY)

    • The network-range is located in a complex

  • TO zone( network-range LocatedIn zone, MANY2MANY)

    • The network-range is located in a zone

  • FROM activity (CHILD of network-range, activity BelongsTo network-range, MANY2ONE)

    • An activity is being performed on a network-range.(1)

  • (1) IF this NETWORK-RANGE node is deleted, this FROM node is DELETED also
network-range-id: string

UUID

network-range-name: string

name

network-range-type: string

type (ex, esi, vni, vni-rt, lacp-id).

network-range-role: string

role of network-range

network-range-function: string

descriptive function

start-range: string

starting range for simple network ranges.

end-range: string

end range for simple network ranges.

last-assigned: string

last assigned value for simple network ranges

range-format: string

Format Decimal, Hexadecimal, etc.

range-prefix: string

Prefix of network range.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-network-resource: object

Instance of a network-resource

  • TO ext-aai-network( network-resource BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • TO vpn-binding( network-resource Uses vpn-binding, ONE2MANY)

    • For CCVPN Usecase

  • FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc BelongsTo network-resource, ONE2MANY)

    • For MDONS Usecase(3)

  • FROM pnf( pnf LinksTo network-resource, MANY2MANY)

    • For CCVPN Usecase(1)

  • (1) IF this NETWORK-RESOURCE node is deleted, this FROM node is DELETED also
  • (3) IF this FROM node is deleted, this NETWORK-RESOURCE is DELETED also
network-id: string

Uniquely identifies this network-resource by id

provider-id: string

Store the id of the provider of this network-resource.

client-id: string

Store the id of the client of this network-resource.

te-topo-id: string

Store the id of the te-topo of this network-resource.

network-resource-type: string

Type of a network topology, e.g., Ethernet, OTN, WSON.

selflink: string

Store the link to get more information for this object.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-network-route: object

This object represents a network route. For instance, host-route, static-route.

  • TO next-hop( network-route Uses next-hop, ONE2MANY)

    • The network-route that is used by the next-hop.

  • TO object-group( network-route MemberOf object-group, MANY2MANY)

    • The route is part of part of a route-list that is modeled in an object-group.

  • TO subnet( network-route MemberOf subnet, MANY2ONE)

    • The route is part of part of a subnet.

  • FROM configuration( configuration Uses network-route, MANY2MANY)

    • Relates configuration to network-route for static routes.

  • FROM l3-network( l3-network Uses network-route, MANY2MANY)

    • Relates l3-network to network-route for static routes.

  • FROM service-instance( service-instance ComposedOf network-route, MANY2MANY)(3)
  • FROM vrf( vrf Uses network-route, MANY2MANY)

    • Relates vrf to network-route for static routes.

  • (3) IF this FROM node is deleted, this NETWORK-ROUTE is DELETED also
  • NETWORK-ROUTE cannot be deleted if related to OBJECT-GROUP
route-id: string

unique identifier example uuid.

type: string

used to categorize this object in conjunction with role & function. The most generic category.

role: string

used to categorize this object in conjunction with type & function.

function: string

used to categorize this object in conjunction with type & role. The most specific category.

ip-address: string

ip address that of the specific network-route.

prefix-length: integer

ip-address prefix length.

logical-interface-id: string

Identity of a logical interface, e.g., VLAN ID.

next-hop: string

Could be ip-address, hostname, or service-instance.

next-hop-type: string

Should be ip-address, hostname, or service-instance to match next-hop.

metric: integer

Value that is assigned to an IP route for a particular network interface that identifies the cost that is associated with using that route.

address-family: string

whether the route address is ipv4, ipv6.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

configuration-status: string

Configuration status of the network route.

relationship-list: object
relationship

zzzz-patch-network-technology: object

The network-technology object is used to capture the supported network technologies of a cloud-region.

  • FROM cloud-region( cloud-region Uses network-technology, MANY2MANY)
network-technology-id: string

Unique identifier of the network-technology object (UUID)

network-technology-name: string

The network-technology that a cloud-region can support. Current valid values- CONTRAIL AIC_SR_IOV OVS STANDARD-SR-IOV

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-newvce: object

This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.

  • FROM l-interface (CHILD of newvce, l-interface BelongsTo newvce, MANY2ONE)(1)

  • (1) IF this NEWVCE node is deleted, this FROM node is DELETED also
vnf-id2: string

Unique id of VNF, can't use same attribute name right now until we promote this new object

vnf-name: string

Name of VNF.

vnf-name2: string

Alternate name of VNF.

vnf-type: string

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

prov-status: string

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

operational-status: string

Indicator for whether the resource is considered operational

license-key: string

OBSOLETE - do not use

ipv4-oam-address: string

Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).

equipment-role: string

Client should send valid enumerated value.

ipv4-loopback0-address: string

v4 Loopback0 address

orchestration-status: string

Orchestration status of this VNF, mastered by MSO.

heat-stack-id: string

Heat stack id corresponding to this instance, managed by MSO

mso-catalog-key: string

Corresponds to the SDN-C catalog id used to configure this VCE

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-next-hop: object

Is among the series of routers that are connected together in a network and is the next possible destination for a data packet.

  • TO bfd( next-hop Uses bfd, ONE2ONE)
  • FROM l-interface( l-interface Uses next-hop, ONE2MANY)

    • The l-interface that is used by the next-hop.

  • FROM network-route( network-route Uses next-hop, ONE2MANY)

    • The network-route that is used by the next-hop.

  • FROM rule( rule Uses next-hop, MANY2MANY)

    • The rule that is used by the next-hop. For CG-NAT these are the ACL policies.

  • FROM vrf( vrf Uses next-hop, MANY2MANY)

    • The vrfs that are used by the next-hop.

next-hop-id: string

UUID.

next-hop-type: string

Used to categorize this object in conjunction with role & function. The most generic category.

next-hop-role: string

Used to categorize this object in conjunction with type & function.

next-hop-function: string

Used to categorize this object in conjunction with type & role. The most specific category.

sequence: integer

Sequence number.

address-family: string

Ipv4 or Ipv6.

ip-address: string

Next hop ip-address.

metric: integer

Cost that is associated with using the route.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-nos-server: object

nos-server is the execution environment that will have images, certain versions of VNOS, running on it.

  • TO pserver( nos-server HostedOn pserver, ONE2ONE)
  • TO tenant (PARENT of nos-server, nos-server BelongsTo tenant, MANY2ONE)
  • FROM generic-vnf( generic-vnf HostedOn nos-server, MANY2ONE)
nos-server-id: string

Unique identifier for this nos relative to its tenant

nos-server-name: string

Name of nos

vendor: string

uCPE vendor

prov-status: string

Trigger for operational monitoring of this resource by Service Assurance systems.

nos-server-selflink: string

URL to endpoint where AAI can get more details

in-maint: boolean

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.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-notification-event: object

cambria.partition: string

zzzz-patch-notification-event-header: object

id: string
timestamp: string
source-name: string
domain: string
sequence-number: string
severity: string
event-type: string
version: string
action: string
entity-type: string
top-entity-type: string
entity-link: string
status: string

zzzz-patch-notify: object

event-id: string
node-type: string
event-trigger: string
selflink: string

zzzz-patch-oam-network: object

OAM network, to be deprecated shortly. Do not use for new purposes.

  • TO cloud-region (PARENT of oam-network, oam-network BelongsTo cloud-region, MANY2ONE)
  • TO complex( oam-network AppliesTo complex, MANY2MANY)
  • TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
network-uuid: string

UUID of the network. Unique across a cloud-region

network-name: string

Name of the network.

cvlan-tag: integer

cvlan-id

ipv4-oam-gateway-address: string

Used for VNF firewall rule so customer cannot send customer traffic over this oam network

ipv4-oam-gateway-address-prefix-length: integer

Used for VNF firewall rule so customer cannot send customer traffic over this oam network

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-object-group: object

describes an object-group

  • TO cloud-region( object-group LocatedIn cloud-region, MANY2MANY)

    • The object-group is located in a cloud-region

  • TO complex( object-group LocatedIn complex, MANY2MANY)

    • The object-group is located in a complex

  • TO object-group( object-group AppliesTo object-group, MANY2MANY)

    • The object-gorup that applies to an object-group

  • TO pnf( object-group AppliesTo pnf, MANY2MANY)
  • TO vrf( object-group AppliesTo vrf, MANY2MANY)

    • The object-group to VRF for various route types.

  • TO zone( object-group LocatedIn zone, MANY2MANY)

    • The object-group is located in a zone

  • FROM community-list (CHILD of object-group, community-list BelongsTo object-group, MANY2ONE)(1)
  • FROM generic-vnf( generic-vnf AppliesTo object-group, MANY2MANY)

    • A relationship that ties the device to the prefix-list/community-list.

  • FROM ip-address-list (CHILD of object-group, ip-address-list BelongsTo object-group, MANY2ONE)(1)
  • FROM l-interface( l-interface MemberOf object-group, ONE2MANY)

    • Member of l-interface

  • FROM mapping( mapping MemberOf object-group, ONE2MANY)

    • The mapping associated to an object-group

  • FROM network-route( network-route MemberOf object-group, MANY2MANY)

    • The route is part of part of a route-list that is modeled in an object-group.

  • FROM object-group( object-group AppliesTo object-group, MANY2MANY)

    • The object-gorup that applies to an object-group

  • FROM platform( platform Uses object-group, ONE2MANY)

    • Used by Auditing applications to identify appropriate audit models based on the platform associated with the given object

  • FROM policy( policy Uses object-group, MANY2MANY)
  • FROM port-list (CHILD of object-group, port-list BelongsTo object-group, MANY2ONE)(1)
  • FROM profile( profile AppliesTo object-group, MANY2MANY)

    • The profile (set of characteristics) classifies the object-group.

  • FROM relationship-rule( relationship-rule AppliesTo object-group, MANY2MANY)

    • Details relationships object-group requires

  • FROM rule( rule Uses object-group, MANY2MANY)
  • FROM rule( rule AppliesTo object-group, MANY2MANY)
  • FROM rule( rule Source object-group, MANY2MANY)
  • FROM rule( rule Destination object-group, MANY2MANY)
  • FROM selector-list (CHILD of object-group, selector-list BelongsTo object-group, MANY2ONE)(1)

  • (1) IF this OBJECT-GROUP node is deleted, this FROM node is DELETED also
  • OBJECT-GROUP cannot be deleted if related to VRF,RULE
object-group-id: string

UUID.

group-type: string

Type of object contained in the list.

group-name: string

Name of the list.

group-name2: string

Alias name for object-group

version: string

used to track the versions of the object

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-operational-environment: object

It is a logical partition of the cloud which allows to have multiple environments in the production AIC.

  • TO operational-environment( operational-environment Uses operational-environment, MANY2MANY)
  • FROM operational-environment( operational-environment Uses operational-environment, MANY2MANY)
operational-environment-id: string

UUID of an operational environment

operational-environment-name: string

Operational Environment name

operational-environment-type: string

Operational Environment Type.

operational-environment-status: string

Status

tenant-context: string

Tenant Context.

workload-context: string

Workload Context.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-overloaded-model: object

Allows for legacy POST of old-style and new-style models

model-invariant-id: string

Unique identifier corresponding to the main definition of a model in ASDC

model-name-version-id: string

Unique identifier corresponding to one version of a model in ASDC

model-type: string

Type of the model, e.g., service, resource, widget, etc.

model-name: string

Name of the model, which can change from version to version.

model-id: string

Invariant unique ID which does not change from version to version

model-version: string

Version

model-description: string

Description

zzzz-patch-owning-entity: object

describes an owning-entity

  • TO tenant( owning-entity Uses tenant, ONE2MANY)
  • TO vlan-range( owning-entity Uses vlan-range, ONE2MANY)

    • An owning-entity uses a vlan-range.

  • FROM pnf( pnf BelongsTo owning-entity, MANY2ONE)
  • FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
  • FROM service-instance( service-instance Uses owning-entity, MANY2ONE)

    • service-instance Uses an owning-entity

  • FROM service-instance( service-instance Uses owning-entity, MANY2ONE)

    • service-instance Uses an owning-entity

owning-entity-id: string

UUID of an owning entity

owning-entity-name: string

Owning entity name

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-p-interface: object

Physical interface (e.g., nic)

  • TO interlayer-attachment( p-interface LinksTo interlayer-attachment, MANY2MANY)

    • For CCVPN Usecase(4)

  • TO logical-link( p-interface LinksTo logical-link, MANY2MANY)(2)
  • TO pnf (PARENT of p-interface, p-interface BindsTo pnf, MANY2ONE)(4)
  • TO pserver (PARENT of p-interface, p-interface BindsTo pserver, MANY2ONE)(4)
  • TO tunnel-termination-point( p-interface BindsTo tunnel-termination-point, MANY2MANY)

    • For CCVPN Usecase(4)

  • TO vpls-pe (PARENT of p-interface, p-interface BindsTo vpls-pe, MANY2ONE)(4)
  • TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
  • FROM activity (CHILD of p-interface, activity AppliesTo p-interface, MANY2MANY)

    • The activity applies to a p-interface.(1)

  • FROM allotted-resource( allotted-resource Uses p-interface, ONE2MANY)

    • AAI-1925 For CCVPN Usecase

  • FROM bandwidth-attribute (CHILD of p-interface, bandwidth-attribute BelongsTo p-interface, MANY2ONE)

    • For MDONS usecase(1)

  • FROM forwarder( forwarder ForwardsTo p-interface, MANY2MANY)
  • FROM gig-ether-option (CHILD of p-interface, gig-ether-option BindsTo p-interface, ONE2ONE)

    • used for generic interface parameters(1)

  • FROM hold-timer (CHILD of p-interface, hold-timer BindsTo p-interface, ONE2ONE)

    • used for generic interface parameters(1)

  • FROM l-interface (CHILD of p-interface, l-interface BindsTo p-interface, MANY2ONE)(1)
  • FROM l3-interface-ipv4-address-list (CHILD of p-interface, l3-interface-ipv4-address-list BelongsTo p-interface, MANY2ONE)

    • A IPv4 address associated with a p-interface.(1)

  • FROM l3-interface-ipv6-address-list (CHILD of p-interface, l3-interface-ipv6-address-list BelongsTo p-interface, MANY2ONE)

    • A IPv6 address associated with a p-interface.(1)

  • FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
  • FROM port( port ComposedOf p-interface, MANY2MANY)

    • A port is composed of one or more p-interfaces.(3)

  • FROM profile( profile AppliesTo p-interface, MANY2MANY)

    • A profile (set of characteristics) applies to the p-interface.

  • FROM service-instance( service-instance ComposedOf p-interface, ONE2MANY)

    • For MDONS Use case

  • FROM sriov-pf (CHILD of p-interface, sriov-pf BelongsTo p-interface, ONE2ONE)(1)
  • FROM temporary-parameter-list (CHILD of p-interface, temporary-parameter-list BindsTo p-interface, MANY2ONE)

    • used for generic interface parameters(1)

  • FROM uni( uni PartOf p-interface, MANY2MANY)

    • For CCVPN Usecase

  • FROM vpn-binding( vpn-binding BindsTo p-interface, ONE2MANY)

    • For CCVPN Usecase

  • (1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
  • (2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
  • (3) IF this FROM node is deleted, this P-INTERFACE is DELETED also
  • (4) IF this TO node is deleted, this P-INTERFACE is DELETED also
interface-name: string

Name that identifies the physical interface

interface-name2: string

Alternate name that identifies the physical interface

selflink: string

URL to endpoint where AAI can get more details.

speed-value: string

Captures the numeric part of the speed

speed-units: string

Captures the units corresponding to the speed

port-description: string

Nature of the services and connectivity on this port.

domain-type: string

Domain type of the SDNC controllerr.

equipment-identifier: string

CLEI or other specification for p-interface hardware.

interface-role: string

Role specification for p-interface hardware.

interface-type: string

Indicates the physical properties of the interface.

network-interface-type: string

Indicates the physical properties of the interface.

prov-status: string

Trigger for operational monitoring of this resource by Service Assurance systems.

mac-addresss: string

MAC Address of the p-interface.

in-maint: boolean

used to indicate whether or not this object is in maintenance mode (maintenance mode = true)

inv-status: string

inventory status

ops-note: string

Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.

interface-function: string

The function performed by this pInterface

macaddr: string

MAC address for the interface

network-ref: string

Store the network-ref of this p-interface. Derived from ietf-restconf-notification that identifies a termination-point.

transparent: string

Store the transparent value of this p-interface.

operational-status: string

oper Status of this p-interface.

inter-domain-plug-id: integer

connect interdomain link

encapsulation: string

specifies the encapsulation type

admin-state: string

At interface inventory, set to value reflecting the state at initial configuration

load-interval: string

Length of time for which data is used to compute load statistics.

lldp: string

Link Layer Discovery Protocol, link layer protocol used by network devices for advertising their identity, capabilities, and neighbors on a local area network based on IEEE 802 technology. Values, enable, disable, NULL

dampening: string

specifies the dampening configuration to slow down the operation of automation scripts executed on the device. Values, NULL (dampening not configured) DEFAULT (dampening w/o options) configures as dampening dampening options configures dampening w/ options

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-parameter-list: object

Parameter list associated with a policy key term

  • FROM class-map-member( class-map-member Uses parameter-list, MANY2MANY)

    • class-map-member to parameter-list

  • FROM policy-key-term( policy-key-term Uses parameter-list, MANY2MANY)

    • policy-key-term to parameter-list

parameter-list-id: string

UUID

parameter-type: string

set to QoS

parameter-role: string

parameter role

parameter-function: string

parameter function

sequence-number: string

numeric indicating the sequence of the parameter

parameter-name: string

name of the parameter

parameter-value: string

numeric value

parameter-value-unit: string

unit of the value parameter, e.g. mbps, ms

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-pdu: object

Definition of pdu

  • TO hardware-catalog-item( pdu IsA hardware-catalog-item, MANY2ONE)

    • The pdu is described by the hardware-catalog-item.

  • TO rack (PARENT of pdu, pdu LocatedIn rack, MANY2ONE)

    • A pdu is located in a building (aka complex).(4)

  • TO rack-unit( pdu Uses rack-unit, ONE2MANY)

    • A pdu uses space in a rack (aka one or more rack-units).

  • FROM profile( profile AppliesTo pdu, MANY2MANY)

    • The profile (set of characteristics) applies to the pdu.

  • (4) IF this TO node is deleted, this PDU is DELETED also
pdu-name: string

A unique name for the power distribution unit.

pdu-type: string

The type of pdu.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-platform: object

describes a platform

  • TO endpoint( platform Uses endpoint, ONE2MANY)

    • Used by Auditing applications to identify appropriate audit models based on the platform associated with the given object

  • TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
  • TO l3-network( platform Uses l3-network, MANY2MANY)
  • TO object-group( platform Uses object-group, ONE2MANY)

    • Used by Auditing applications to identify appropriate audit models based on the platform associated with the given object

  • TO policy( platform Uses policy, ONE2MANY)

    • Used by Auditing applications to identify appropriate audit models based on the platform associated with the given object

  • TO profile( platform Uses profile, ONE2MANY)

    • Used by Auditing applications to identify appropriate audit models based on the platform associated with the given object

platform-name: string

Name of the platform

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-pluggable: object

Definition of pluggable

  • TO cable( pluggable PartOf cable, MANY2ONE)

    • A pluggable that is intergrated with a cable.(4)

  • TO hardware-catalog-item( pluggable IsA hardware-catalog-item, MANY2ONE)

    • The pluggable is described by the hardware-catalog-item.

  • TO pluggable-slot (PARENT of pluggable, pluggable LocatedIn pluggable-slot, ONE2ONE)

    • A pluggable is located in a pluggable-slot.(4)

  • FROM port (CHILD of pluggable, port LocatedIn pluggable, MANY2ONE)

    • A port is located in a pluggable.(1)

  • FROM profile( profile AppliesTo pluggable, MANY2MANY)

    • The profile (set of characteristics) applies to the pluggable.

  • (1) IF this PLUGGABLE node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this PLUGGABLE is DELETED also
pluggable-type: string

The type of pluggable.

part-number: string

Part number for this pluggable.

equip-identifier: string

CLEI or other specification for pluggable hardware.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-pluggable-slot: object

Definition of card-slot

  • TO card (PARENT of pluggable-slot, pluggable-slot LocatedIn card, MANY2ONE)

    • A pluggable slot is located in a card.(4)

  • TO chassis (PARENT of pluggable-slot, pluggable-slot LocatedIn chassis, MANY2ONE)

    • A pluggable-slot is located in a chassis.(4)

  • FROM pluggable (CHILD of pluggable-slot, pluggable LocatedIn pluggable-slot, ONE2ONE)

    • A pluggable is located in a pluggable-slot.(1)

  • (1) IF this PLUGGABLE-SLOT node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this PLUGGABLE-SLOT is DELETED also
slot-name: string

The name of the pluggable-slot. (unique relative to the chassis or card).

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-pnf: object

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.

  • TO autonomous-system( pnf LocatedIn autonomous-system, MANY2ONE)

    • pnf is located in the autonomous-system.

  • TO cloud-region( pnf LocatedIn cloud-region, MANY2ONE)

    • A pnf is located in (aka supports) a cloud-region.

  • TO cloud-region( pnf Uses cloud-region, MANY2MANY)

    • used for CSP pnf to cloud-region.

  • TO complex( pnf LocatedIn complex, MANY2ONE)
  • TO endpoint( pnf Uses endpoint, MANY2MANY)
  • TO ext-aai-network( pnf BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • TO hw-component( pnf MemberOf hw-component, MANY2ONE)

    • The hw-component associated to a pnf

  • TO instance-group( pnf MemberOf instance-group, MANY2MANY)
  • TO instance-group( pnf Primary instance-group, MANY2MANY)
  • TO instance-group( pnf Secondary instance-group, MANY2MANY)
  • TO network-resource( pnf LinksTo network-resource, MANY2MANY)

    • For CCVPN Usecase(4)

  • TO owning-entity( pnf BelongsTo owning-entity, MANY2ONE)
  • TO policy( pnf Uses policy, MANY2MANY)

    • A pnf uses policies

  • TO project( pnf PartOf project, MANY2ONE)

    • The pnf is part of a project (ex, VPMO that ordered the equipment).

  • TO sw-component( pnf MemberOf sw-component, MANY2ONE)

    • The sw-component associated to a pnf

  • TO zone( pnf LocatedIn zone, MANY2ONE)
  • FROM activity (CHILD of pnf, activity AppliesTo pnf, MANY2MANY)

    • The activity applies to a pnf.(1)

  • FROM bgp-group (CHILD of pnf, bgp-group BelongsTo pnf, MANY2ONE)

    • A bgp-group belongs to a pnf.(1)

  • FROM bgp-neighbor (CHILD of pnf, bgp-neighbor BelongsTo pnf, MANY2ONE)

    • A bgp-neighbor belongs to a pnf.(1)

  • FROM chassis( chassis PartOf pnf, MANY2ONE)

    • A chassis is part of a pnf.

  • FROM configuration( configuration AppliesTo pnf, MANY2MANY)
  • FROM contact( contact Supports pnf, ONE2MANY)

    • The contact supports a pnf.

  • FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
  • FROM generic-vnf( generic-vnf HostedOn pnf, MANY2MANY)
  • FROM l-interface (CHILD of pnf, l-interface BelongsTo pnf, MANY2ONE)

    • A logical interface associated with a pnf.(1)

  • FROM lag-interface (CHILD of pnf, lag-interface BindsTo pnf, MANY2ONE)(1)
  • FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
  • FROM mapping( mapping MemberOf pnf, ONE2MANY)

    • The mapping associated to a pnf

  • FROM metadatum( metadatum AppliesTo pnf, MANY2MANY)

    • AAI-2154 For BBS Usecase

  • FROM object-group( object-group AppliesTo pnf, MANY2MANY)
  • FROM p-interface (CHILD of pnf, p-interface BindsTo pnf, MANY2ONE)(1)
  • FROM profile( profile supports pnf, MANY2MANY)
  • FROM profile( profile AppliesTo pnf, MANY2MANY)

    • A profile (set of characteristics) applies to the pnf.

  • FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
  • FROM software-version (CHILD of pnf, software-version BelongsTo pnf, MANY2ONE)
  • FROM tunnel-termination-point( tunnel-termination-point BindsTo pnf, MANY2MANY)

    • For CCVPN Usecase(1)

  • FROM vrf (CHILD of pnf, vrf BelongsTo pnf, MANY2ONE)

    • A vrf belongs to a pnf.(1)

  • (1) IF this PNF node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this PNF is DELETED also
  • PNF cannot be deleted if related to SOFTWARE-VERSION
pnf-name: string

unique name of Physical Network Function.

pnf-name2: string

name of Physical Network Function.

selflink: string

URL to endpoint where AAI can get more details.

pnf-name2-source: string

source of name2

pnf-id: string

id of pnf

nf-naming-code: string

Naming code for network function

network-operating-system: string

Network operating system used on the device.

nf-function: string

The function performed by the pnf.

equip-type: string

Equipment type. Source of truth should define valid values.

equip-vendor: string

Equipment vendor. Source of truth should define valid values.

equip-model: string

Equipment model. Source of truth should define valid values.

management-option: string

identifier of managed customer

orchestration-status: string

Orchestration status of this pnf

ipaddress-v4-oam: string

ipv4-oam-address with new naming convention for IP addresses

sw-version: string

sw-version is the version of SW for the hosted application on the PNF.

in-maint: boolean

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.

frame-id: string

ID of the physical frame (relay rack) where pnf is installed.

serial-number: string

Serial number of the device

ipaddress-v4-loopback-0: string

IPV4 Loopback 0 address

ipaddress-v6-loopback-0: string

IPV6 Loopback 0 address

ipaddress-v4-aim: string

IPV4 AIM address

ipaddress-v6-aim: string

IPV6 AIM address

ipaddress-v6-oam: string

IPV6 OAM address

inv-status: string

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

spare-equipment-indicator: boolean

Flag for identifying spare equipment

prov-status: string

Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]

nf-role: string

Nf Role is the role performed by this instance in the network.

admin-status: string

admin Status of this PNF

operational-status: string

Store the operational-status for this object.

model-customization-id: string

Store the model-customization-id for this object.

model-invariant-id: string

The ASDC model id for this resource model.

model-version-id: string

The ASDC model version for this resource model.

ops-note: string

Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.

config-validation-request-id: string

Contains the value of the request id to the most recent configuration file/validation report for this PNF.

config-validation-status: string

Status of latest configuration attempt represented by the config-url.

nf-type: string

Subtype used to categorize this pnf

common-base-indicator: string

Indicates the PNF/R-Leaf was built with the VNF agnostic common base

equipment-clli: string

11-character equipment CLLI.

pnf-ipv4-address: string

This is the IP address (IPv4) for the PNF itself. This is the IPv4 address that the PNF iself can be accessed at.

pnf-ipv6-address: string

This is the IP address (IPv6) for the PNF itself. This is the IPv6 address that the PNF iself can be accessed at.

phone-number: string

Identifies the POTS phone number used to connect to a pnf out-of-band via dial-up.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-policy: object

Definition of policy

  • TO address-family( policy AppliesTo address-family, MANY2MANY)

    • A policy applies to an address family.

  • TO bgp-group( policy AppliesTo bgp-group, MANY2MANY)

    • A policy applies to a bgp-group.

  • TO bgp-neighbor( policy AppliesTo bgp-neighbor, MANY2MANY)

    • A policy applies to a bgp-neighbor.

  • TO instance-group( policy AppliesTo instance-group, MANY2ONE)

    • The policy associated to an instance-group

  • TO l-interface( policy AppliesTo l-interface, MANY2MANY)

    • The policy applies to an l-interface.

  • TO l3-network( policy AppliesTo l3-network, MANY2MANY)

    • A policy applies to l3-networks.

  • TO lag-interface( policy AppliesTo lag-interface, MANY2MANY)

    • used to support NCX-Hub

  • TO object-group( policy Uses object-group, MANY2MANY)
  • TO rule (PARENT of policy, policy Implements rule, ONE2MANY)(2)
  • TO vlan-tag( policy AppliesTo vlan-tag, MANY2MANY)

    • 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.

  • TO vpn-binding( policy Uses vpn-binding, ONE2MANY)

    • A policy uses vpn-bindings

  • TO vrf( policy AppliesTo vrf, MANY2MANY)
  • FROM cloud-region( cloud-region Implements policy, MANY2MANY)

    • a cloud-region implements policies

  • FROM configuration( configuration Uses policy, MANY2MANY)

    • A configuration uses a policy

  • FROM ip-address-list (CHILD of policy, ip-address-list BelongsTo policy, MANY2ONE)

    • An ip-address-list BelongsTo a policy.(1)

  • FROM mapping( mapping MemberOf policy, ONE2MANY)

    • The mapping associated to a policy

  • FROM platform( platform Uses policy, ONE2MANY)

    • Used by Auditing applications to identify appropriate audit models based on the platform associated with the given object

  • FROM pnf( pnf Uses policy, MANY2MANY)

    • A pnf uses policies

  • FROM policy-map-member( policy-map-member MemberOf policy, MANY2ONE)

    • Member of policy map

  • FROM profile( profile AppliesTo policy, MANY2MANY)

    • A profile (set of characteristics) applies to the policy.

  • FROM pserver( pserver Implements policy, MANY2MANY)
  • FROM relationship-rule( relationship-rule AppliesTo policy, MANY2MANY)

    • Details relationships policy requires.

  • FROM selector-list (CHILD of policy, selector-list BelongsTo policy, MANY2ONE)(1)

  • (1) IF this POLICY node is deleted, this FROM node is DELETED also
  • (2) IF this POLICY node is deleted, this TO node is DELETED also
  • POLICY cannot be deleted if related to ADDRESS-FAMILY,BGP-GROUP,BGP-NEIGHBOR,VLAN-TAG,POLICY-MAP-MEMBER
policy-id: string

Unique Policy UUID.

policy-name: string

Policy Name

policy-type: string

Policy Type

policy-role: string

Policy role

policy-function: string

policy function

do-not-track: boolean

Do not track

pre-dnat: boolean

Pre destination NAT

apply-on-forward: boolean

apply on forward

selector: string

Host and Interface Type Selector

order: integer

Order

version: string

Version

status: string

Status

remote-asn: integer

Remote ASN

namespace: string

Namespace filter to apply the policy

policy-description: string

Description of the policy

policy-variables: string

Set of rule variables

policy-variable-name: string

Policy Variable Name

direction: string

policy direction set as ingress or egress

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-policy-key-term: object

Policy key term related to a policy map member

  • TO parameter-list( policy-key-term Uses parameter-list, MANY2MANY)

    • policy-key-term to parameter-list

  • FROM policy-map-member( policy-map-member Uses policy-key-term, ONE2MANY)

    • Policy key term related to policy map member

  • POLICY-KEY-TERM cannot be deleted if related to PARAMETER-LIST
policy-key-term-id: string

unique ID

sequence-number: string

numeric indicating the sequence of the key term

key-word: string

key word, for example police, set, priority level, shape

key-word-qualifier: string

qualifier, for example rate, traffic class, avg percent

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-policy-map-member: object

Member of a policy map used for QOS

  • TO class-map( policy-map-member Uses class-map, MANY2MANY)

    • Class-map related to policy-map-member

  • TO policy-key-term( policy-map-member Uses policy-key-term, ONE2MANY)

    • Policy key term related to policy map member

  • TO policy( policy-map-member MemberOf policy, MANY2ONE)

    • Member of policy map

  • POLICY-MAP-MEMBER cannot be deleted if related to CLASS-MAP,POLICY-KEY-TERM
policy-map-member-id: string

unique ID

sequence-number: string

indicate the sequence of the member

member-type: string

valid values are QOS-CLASS or END-POLICY-MAP

qos-class-name: string

used to map to the class-map

class-type: string

valid value is traffic

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-port: object

Definition of port

  • TO cable( port LinksTo cable, MANY2ONE)

    • A channel-interface terminates a channel-link.

  • TO card (PARENT of port, port LocatedIn card, MANY2ONE)

    • A port is located in a card.(4)

  • TO chassis (PARENT of port, port LocatedIn chassis, MANY2ONE)

    • A port is LocatedIn a chassis.(4)

  • TO p-interface( port ComposedOf p-interface, MANY2MANY)

    • A port is composed of one or more p-interfaces.(2)

  • TO pluggable (PARENT of port, port LocatedIn pluggable, MANY2ONE)

    • A port is located in a pluggable.(4)

  • TO port( port LinksTo port, ONE2ONE)

    • A port LinksTo another port.

  • FROM logical-link( logical-link Uses port, ONE2MANY)

    • The port associated with a logical-link(3)

  • FROM port( port LinksTo port, ONE2ONE)

    • A port LinksTo another port.

  • (2) IF this PORT node is deleted, this TO node is DELETED also
  • (3) IF this FROM node is deleted, this PORT is DELETED also
  • (4) IF this TO node is deleted, this PORT is DELETED also
  • PORT cannot be deleted if related to CABLE
port-name: string

A unique name for the port relative to the containing hardware.

port-type: string

The type of port.

port-role: string

The role of the port.

speed-value: string

The numeric value for the speed of the port.

speed-units: string

The units for the speed of the port.

xcvr-type: string

Type of transceiver that creates this port.

equip-identifier: string

clei-code or other similar identifier

part-number: string

part number

port-start: string

Port range start

port-end: string

Port range end

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-port-group: object

Used to capture the network interfaces of this VCE

  • TO vce (PARENT of port-group, port-group BelongsTo vce, MANY2ONE)(4)
  • FROM cvlan-tag (CHILD of port-group, cvlan-tag BelongsTo port-group, MANY2ONE)(1)

  • (1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this PORT-GROUP is DELETED also
interface-id: string

Unique ID of the interface

neutron-network-id: string

Neutron network id of this Interface

neutron-network-name: string

Neutron network name of this Interface

interface-role: string

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

port-group-id: string

Unique ID for port group in vmware

port-group-name: string

Likely to duplicate value of neutron network name

switch-name: string

DVS or standard switch name (should be non-null for port groups associated with DVS)

orchestration-status: string

Orchestration status of this VNF, mastered by MSO

heat-stack-id: string

Heat stack id corresponding to this instance, managed by MSO

mso-catalog-key: string

Corresponds to the SDN-C catalog id used to configure this VCE

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-port-list: object

Port List Range

  • TO endpoint (PARENT of port-list, port-list BelongsTo endpoint, MANY2ONE)(4)
  • TO object-group (PARENT of port-list, port-list BelongsTo object-group, MANY2ONE)(4)
  • TO rule (PARENT of port-list, port-list BelongsTo rule, MANY2ONE)(4)
  • FROM ip-address-list( ip-address-list BelongsTo port-list, MANY2MANY)

  • (4) IF this TO node is deleted, this PORT-LIST is DELETED also
port: string

Port number

assignment: string

Name or assignment for the port

type: string

Type or usage of the port

operator: string

Operator to apply to the port (greater than, less than, etc).

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-profile: object

describes an profiles

  • TO card( profile AppliesTo card, MANY2MANY)

    • The profile (set of characteristics) applies to the card.

  • TO chassis( profile AppliesTo chassis, MANY2MANY)

    • The profile (set of characteristics) applies to the chassis.

  • TO cloud-region( profile AppliesTo cloud-region, MANY2MANY)
  • TO endpoint( profile AppliesTo endpoint, MANY2MANY)

    • A profile (set of characteristics) applies to the endpoint.

  • TO hardware-catalog-item( profile AppliesTo hardware-catalog-item, MANY2MANY)

    • A set of characteristics of the hardware-catalog-item.

  • TO instance-group( profile AppliesTo instance-group, MANY2MANY)

    • A profile (set of characteristics) applies to the instance-group (as a vrrp group).

  • TO l-interface( profile AppliesTo l-interface, MANY2MANY)

    • A profile (set of characteristics) applies to the l-interface.

  • TO l3-network( profile AppliesTo l3-network, MANY2MANY)

    • A profile (set of characteristics) applies to the l3-network.

  • TO lag-interface( profile AppliesTo lag-interface, MANY2MANY)

    • A profile (set of characteristics) applies to the lag-interface.

  • TO logical-link( profile AppliesTo logical-link, MANY2MANY)

    • A profile (set of characteristics) applies to the logical-link.

  • TO object-group( profile AppliesTo object-group, MANY2MANY)

    • The profile (set of characteristics) classifies the object-group.

  • TO p-interface( profile AppliesTo p-interface, MANY2MANY)

    • A profile (set of characteristics) applies to the p-interface.

  • TO pdu( profile AppliesTo pdu, MANY2MANY)

    • The profile (set of characteristics) applies to the pdu.

  • TO physical-link( profile AppliesTo physical-link, MANY2MANY)

    • A profile (set of characteristics) applies to the physical-link.

  • TO pluggable( profile AppliesTo pluggable, MANY2MANY)

    • The profile (set of characteristics) applies to the pluggable.

  • TO pnf( profile supports pnf, MANY2MANY)
  • TO pnf( profile AppliesTo pnf, MANY2MANY)

    • A profile (set of characteristics) applies to the pnf.

  • TO policy( profile AppliesTo policy, MANY2MANY)

    • A profile (set of characteristics) applies to the policy.

  • TO pserver( profile supports pserver, MANY2MANY)
  • TO pserver( profile AppliesTo pserver, MANY2MANY)

    • A profile (set of characteristics) applies to the pserver.

  • TO rack( profile AppliesTo rack, MANY2MANY)

    • The profile (set of characteristics) applies to the rack.

  • TO subnet( profile AppliesTo subnet, MANY2MANY)

    • A profile (set of characteristics) applies to the subnet.

  • TO vlan-range( profile AppliesTo vlan-range, MANY2MANY)

    • A profile (set of characteristics) applies to the vlan-range.

  • TO vlan-tag( profile AppliesTo vlan-tag, MANY2MANY)

    • A profile (set of characteristics) applies to the vlan-tag.

  • TO vpn-binding( profile AppliesTo vpn-binding, MANY2MANY)

    • A profile (set of characteristics) applies to the vpn-binding.

  • TO vrf( profile AppliesTo vrf, MANY2MANY)

    • A profile (set of characteristics) applies to the vrf.

  • TO vserver( profile supports vserver, MANY2MANY)
  • FROM hw-component( hw-component AppliesTo profile, MANY2MANY)

    • The profile associated to a hw-component

  • FROM metadatum (CHILD of profile, metadatum BelongsTo profile, MANY2ONE)(1)
  • FROM platform( platform Uses profile, ONE2MANY)

    • Used by Auditing applications to identify appropriate audit models based on the platform associated with the given object

  • FROM relationship-rule( relationship-rule AppliesTo profile, MANY2MANY)

    • Details relationships profile requires.

  • FROM sw-component( sw-component AppliesTo profile, MANY2MANY)

    • The profile associated to a sw-component

  • (1) IF this PROFILE node is deleted, this FROM node is DELETED also
  • PROFILE cannot be deleted if related to CARD,CHASSIS,ENDPOINT,HARDWARE-CATALOG-ITEM,INSTANCE-GROUP,L-INTERFACE,L3-NETWORK,LAG-INTERFACE,LOGICAL-LINK,OBJECT-GROUP,P-INTERFACE,PDU,PHYSICAL-LINK,PLUGGABLE,PNF,POLICY,PSERVER,RACK,SUBNET,VLAN-RANGE,VLAN-TAG,VPN-BINDING,VRF
profile-name: string

Name of the profile

profile-type: string

Type of profile (ex,network-power-profile)

profile-characteristics: string

Set of characteristics of the profile.

profile-subtype: string

Descriptive subtype.

profile-role: string

used to categorize this object in conjunction with profile-type and profile-function.

profile-function: string

used to categorize this object in conjunction with profile-type and profile-role. The most specific category

profile-selflink: string

URL to endpoint where AAI can get more details

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-project: object

describes the project

  • TO service-instance( project Uses service-instance, ONE2MANY)
  • FROM cloud-region( cloud-region PartOf project, MANY2ONE)

    • The cloud-region is part of a project (ex, project that built out the cloud region).

  • FROM pnf( pnf PartOf project, MANY2ONE)

    • The pnf is part of a project (ex, VPMO that ordered the equipment).

  • FROM pserver( pserver PartOf project, MANY2ONE)

    • The pserver is part of a project (ex, VPMO that ordered the equipment).

project-name: string

Name of the project deploying a service

project-type: string

Type of project (ex, VPMO)

project-state: string

Current state of the project.

description: string

Description of the project.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-properties: object

Property holder for query properties or instance properties

property-name: string
property-value: string

zzzz-patch-property-constraint: object

TBD

  • TO named-query-element (PARENT of property-constraint, property-constraint BelongsTo named-query-element, MANY2ONE)(4)

  • (4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
property-constraint-uuid: string
constraint-type: string
property-name: string
property-value: string

zzzz-patch-pserver: object

Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.

  • TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
  • TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
  • TO complex( pserver LocatedIn complex, MANY2ONE)
  • TO endpoint( pserver Uses endpoint, MANY2MANY)
  • TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
  • TO hw-component( pserver MemberOf hw-component, MANY2ONE)

    • The hw-component associated to a pserver

  • TO policy( pserver Implements policy, MANY2MANY)
  • TO project( pserver PartOf project, MANY2ONE)

    • The pserver is part of a project (ex, VPMO that ordered the equipment).

  • TO sw-component( pserver MemberOf sw-component, MANY2ONE)

    • The sw-component associated to a pserver

  • TO zone( pserver LocatedIn zone, MANY2ONE)
  • FROM activity (CHILD of pserver, activity AppliesTo pserver, MANY2MANY)

    • The activity applies to a pserver.(1)

  • FROM chassis( chassis PartOf pserver, MANY2MANY)

    • A chassis is part of a pserver.

  • FROM contact( contact Supports pserver, ONE2MANY)

    • The contact supports a pserver.

  • FROM flavor( flavor CanBeInstantiatedIn pserver, MANY2MANY)

    • HPA Capacity getting the compute nodes from given flavor

  • FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
  • FROM host-aggregate( host-aggregate BelongsTo pserver, MANY2ONE)
  • FROM hpa-capacity (CHILD of pserver, hpa-capacity BelongsTo pserver, MANY2ONE)

    • HPA Capacity KV for given compute node(1)

  • FROM l-interface (CHILD of pserver, l-interface BelongsTo pserver, MANY2ONE)

    • A logical interface associated with a pserver.(1)

  • FROM lag-interface (CHILD of pserver, lag-interface BindsTo pserver, MANY2ONE)(1)
  • FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
  • FROM nos-server( nos-server HostedOn pserver, ONE2ONE)
  • FROM p-interface (CHILD of pserver, p-interface BindsTo pserver, MANY2ONE)(1)
  • FROM profile( profile supports pserver, MANY2MANY)
  • FROM profile( profile AppliesTo pserver, MANY2MANY)

    • A profile (set of characteristics) applies to the pserver.

  • FROM vserver( vserver HostedOn pserver, MANY2ONE)

  • (1) IF this PSERVER node is deleted, this FROM node is DELETED also
  • PSERVER cannot be deleted if related to ENDPOINT,GROUP-ASSIGNMENT,GENERIC-VNF,LOGICAL-LINK,NOS-SERVER,VSERVER
hostname: string

Value from executing hostname on the compute node.

ptnii-equip-name: string

PTNII name

number-of-cpus: integer

Number of cpus

disk-in-gigabytes: integer

Disk size, in GBs

ram-in-megabytes: integer

RAM size, in MBs

equip-type: string

Equipment type. Source of truth should define valid values.

equip-vendor: string

Equipment vendor. Source of truth should define valid values.

equip-model: string

Equipment model. Source of truth should define valid values.

fqdn: string

Fully-qualified domain name

pserver-selflink: string

URL to endpoint where AAI can get more details

ipv4-oam-address: string

Used to configure device, also used for troubleshooting and is IP used for traps generated by device.

serial-number: string

Serial number, may be queried

ipaddress-v4-loopback-0: string

IPV4 Loopback 0 address

ipaddress-v6-loopback-0: string

IPV6 Loopback 0 address

ipaddress-v4-aim: string

IPV4 AIM address

ipaddress-v6-aim: string

IPV6 AIM address

ipaddress-v6-oam: string

IPV6 OAM address

inv-status: string

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

pserver-id: string

ID of Pserver

internet-topology: string

internet topology of Pserver

in-maint: boolean

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.

pserver-name2: string

alternative pserver name

purpose: string

purpose of pserver

prov-status: string

Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]

management-option: string

Indicates who owns and or manages the device.

host-profile: string

The host profile that defines the configuration of the pserver.

role: string

The role performed by the pserver.

function: string

The function performed by the pserver.

ops-note: string

Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

operational-status: string

Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.

relationship-list: object
relationship

zzzz-patch-rack: object

Definition of rack

  • TO complex (PARENT of rack, rack LocatedIn complex, MANY2ONE)

    • A rack is located in a complex (aka building).(4)

  • TO hardware-catalog-item( rack IsA hardware-catalog-item, MANY2ONE)

    • The rack is this item from the hardware-catalog.

  • TO instance-group( rack MemberOf instance-group, MANY2ONE)

    • The rack is a member of the instance-group (rack-group or pod).

  • FROM chassis( chassis LocatedIn rack, MANY2ONE)

    • A chassis is LocatedIn a rack.

  • FROM pdu (CHILD of rack, pdu LocatedIn rack, MANY2ONE)

    • A pdu is located in a building (aka complex).(1)

  • FROM profile( profile AppliesTo rack, MANY2MANY)

    • The profile (set of characteristics) applies to the rack.

  • FROM rack-unit (CHILD of rack, rack-unit LocatedIn rack, MANY2ONE)

    • A rack-unit is located in a rack.(1)

  • (1) IF this RACK node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this RACK is DELETED also
  • RACK cannot be deleted if related to CHASSIS
rack-name: string

A unique name for the rack (within the location).

rack-type: string

The type of rack.

rack-location: string

The location of the rack within the building.

rack-position: string

The position of the rack (ex-floor-mounted).

rack-power-diversity: boolean
data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-rack-unit: object

Definition of rack-unit

  • TO rack (PARENT of rack-unit, rack-unit LocatedIn rack, MANY2ONE)

    • A rack-unit is located in a rack.(4)

  • FROM chassis( chassis Uses rack-unit, ONE2MANY)

    • A chassis uses space in a rack (aka one or more rack-units).

  • FROM pdu( pdu Uses rack-unit, ONE2MANY)

    • A pdu uses space in a rack (aka one or more rack-units).

  • (4) IF this TO node is deleted, this RACK-UNIT is DELETED also
  • RACK-UNIT cannot be deleted if related to CHASSIS,PDU
rack-unit-name: string

A unique name for the rack-unit (within the rack).

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-relationship-component: object

describes an relationship component

  • TO relationship-rule (PARENT of relationship-component, relationship-component BelongsTo relationship-rule, MANY2ONE)

    • Defines the traversal needed to reach the node of relationship-rule(4)

  • (4) IF this TO node is deleted, this RELATIONSHIP-COMPONENT is DELETED also
rule-node: string

NARAD object

rule-property: string

Object property

rule-value: string

Property value

component-order: integer

Order in traversal

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-relationship-data: object

relationship-key: string

A keyword provided by A&AI to indicate an attribute.

relationship-value: string

Value of the attribute.

zzzz-patch-relationship-properties: object

data-owner: string

Key part of a key/value pair

data-source: string

Key part of a key/value pair

data-source-version: string

Key part of a key/value pair

zzzz-patch-relationship-rule: object

describes an relationship rule

  • TO endpoint( relationship-rule AppliesTo endpoint, MANY2MANY)

    • Details relationships endpoint requires

  • TO object-group( relationship-rule AppliesTo object-group, MANY2MANY)

    • Details relationships object-group requires

  • TO policy( relationship-rule AppliesTo policy, MANY2MANY)

    • Details relationships policy requires.

  • TO profile( relationship-rule AppliesTo profile, MANY2MANY)

    • Details relationships profile requires.

  • FROM relationship-component (CHILD of relationship-rule, relationship-component BelongsTo relationship-rule, MANY2ONE)

    • Defines the traversal needed to reach the node of relationship-rule(1)

  • (1) IF this RELATIONSHIP-RULE node is deleted, this FROM node is DELETED also
  • RELATIONSHIP-RULE cannot be deleted if related to ENDPOINT
rule-id: string

UUID.

context: string

Example global,site

rule-traversals: integer

Number of traversals

applies-to: string

Node the related object applies to

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-reserved-prop-names: object

Internal map to define some reserved properties of a vertex

last-mod-source-of-truth: string
aai-node-type: string
aai-created-ts: integer
aai-unique-key: string
aai-last-mod-ts: integer
source-of-truth: string
aai-uri: string

zzzz-patch-result-data: object

resource-type: string

The specific type of node in the A&AI graph

resource-link: string

The URL to the specific resource

zzzz-patch-route-table-reference: object

Openstack route table reference.

  • FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
route-table-reference-id: string

Route Table Reference id, UUID assigned to this instance.

route-table-reference-fqdn: string

FQDN entry in the route table.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-route-target: object

Route target information

  • TO vpn-binding (PARENT of route-target, route-target BelongsTo vpn-binding, MANY2ONE)(4)
  • TO vrf (PARENT of route-target, route-target BelongsTo vrf, MANY2ONE)(4)

  • (4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
global-route-target: string

Number used to identify an RT, globally unique in the network

route-target-role: string

Role assigned to this route target

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-routing-instance: object

Collection of routing tables, interfaces, and routing protocol parameters.

  • TO site-pair-set (PARENT of routing-instance, routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
  • FROM site-pair (CHILD of routing-instance, site-pair BelongsTo routing-instance, MANY2ONE)(1)

  • (1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
routing-instance-id: string

Unique id of routing instance

rpm-owner: string

rpm owner

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-rule: object

describes an rules

  • TO next-hop( rule Uses next-hop, MANY2MANY)

    • The rule that is used by the next-hop. For CG-NAT these are the ACL policies.

  • TO object-group( rule Uses object-group, MANY2MANY)
  • TO object-group( rule AppliesTo object-group, MANY2MANY)
  • TO object-group( rule Source object-group, MANY2MANY)
  • TO object-group( rule Destination object-group, MANY2MANY)
  • FROM ip-address-list (CHILD of rule, ip-address-list BelongsTo rule, MANY2ONE)(1)
  • FROM metadatum (CHILD of rule, metadatum BelongsTo rule, MANY2ONE)(1)
  • FROM policy (PARENT of rule, policy Implements rule, ONE2MANY)(3)
  • FROM port-list (CHILD of rule, port-list BelongsTo rule, MANY2ONE)(1)
  • FROM selector-list (CHILD of rule, selector-list BelongsTo rule, MANY2ONE)(1)

  • (1) IF this RULE node is deleted, this FROM node is DELETED also
  • (3) IF this FROM node is deleted, this RULE is DELETED also
rule-id: string

UUID.

direction: string

ingress or egress

protocol: string

Positive protocol match. tcp, udp, icmpv6, sctp, udplite, integer 1-255.

not-protocol: string

Negative protocol match. tcp, udp, icmpv6, sctp, udplite, integer 1-255.

action: string

Action to perform when matching this rule.

icmp: string
not-icmp: string
sequence: integer

Sequence number of the rule.

threshold: integer

Threshold

status: string

status

version: string

Version

count-variable: string

Named variable used for counting transactions.

log: boolean

Boolean to indicate whether or not logging is required.

description: string

Description.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-sdwan-vpn: object

Instance of an sdwan-vpn

  • TO ext-aai-network( sdwan-vpn BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • TO generic-vnf( sdwan-vpn PartOf generic-vnf, MANY2MANY)

    • For CCVPN Usecase

  • TO service-instance( sdwan-vpn PartOf service-instance, ONE2MANY)

    • For CCVPN Usecase

  • TO tenant( sdwan-vpn PartOf tenant, ONE2MANY)

    • For CCVPN Usecase

  • TO vpn-binding( sdwan-vpn PartOf vpn-binding, ONE2MANY)

    • For CCVPN Usecase

sdwan-vpn-id: string

Uniquely identifies this sdwan-vpn by id

sdwan-vpn-name: string

Store the name of this sdwan-vpn.

vxlan-id: string

Store the vxlan-id of this sdwan-vpn.

topology: string

Store the topology of this sdwan-vpn.

tenant-id: string

Store the tenant-id of this sdwan-vpn.

vpn-id: string

Store the vpn-id of this sdwan-vpn.

selflink: string

Store the link to get more information for this object.

operational-status: string

Store the operational-status for this object.

model-customization-id: string

Store the model-customization-id for this object.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-secondary-filter: object

property-name: string
filter-type: string
property-value: string

zzzz-patch-segmentation-assignment: object

Openstack segmentation assignment.

  • TO l3-network (PARENT of segmentation-assignment, segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)

  • (4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
segmentation-id: string

Route Table Reference id, UUID assigned to this instance.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-selector-list: object

Selectors list

  • TO endpoint (PARENT of selector-list, selector-list BelongsTo endpoint, MANY2ONE)(4)
  • TO object-group (PARENT of selector-list, selector-list BelongsTo object-group, MANY2ONE)(4)
  • TO policy (PARENT of selector-list, selector-list BelongsTo policy, MANY2ONE)(4)
  • TO rule (PARENT of selector-list, selector-list BelongsTo rule, MANY2ONE)(4)

  • (4) IF this TO node is deleted, this SELECTOR-LIST is DELETED also
selector: string

Selector

assignment: string

Name or assignment for the selector

type: string

Type or usage of the selector

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-service: object

Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.

service-id: string

This gets defined by others to provide a unique ID for the service, we accept what is sent.

service-description: string

Description of the service

service-selflink: string

URL to endpoint where AAI can get more details

service-version: string

service version

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-service-capability: object

Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.

  • FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
  • FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)

  • SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
service-type: string

This gets defined by others to provide a unique ID for the service, we accept what is sent.

vnf-type: string

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.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-service-instance: object

Instance of a service

  • TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
  • TO collection( service-instance ComposedOf collection, ONE2ONE)
  • TO composed-resource( service-instance BelongsTo composed-resource, ONE2ONE)
  • TO configuration( service-instance Uses configuration, ONE2MANY)
  • TO configuration( service-instance ComposedOf configuration, MANY2MANY)
  • TO connector( service-instance Uses connector, MANY2MANY)
  • TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
  • TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
  • TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
  • TO instance-group( service-instance Uses instance-group, ONE2MANY)

    • MSO creates this edge on VNF Group Service creation

  • TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
  • TO l3-network( service-instance ComposedOf l3-network, MANY2MANY)
  • TO logical-link( service-instance Uses logical-link, MANY2MANY)(2)
  • TO network-route( service-instance ComposedOf network-route, MANY2MANY)(2)
  • TO owning-entity( service-instance BelongsTo owning-entity, MANY2ONE)
  • TO owning-entity( service-instance Uses owning-entity, MANY2ONE)

    • service-instance Uses an owning-entity

  • TO owning-entity( service-instance Uses owning-entity, MANY2ONE)

    • service-instance Uses an owning-entity

  • TO p-interface( service-instance ComposedOf p-interface, ONE2MANY)

    • For MDONS Use case

  • TO pnf( service-instance ComposedOf pnf, ONE2MANY)
  • TO service-instance( service-instance ComposedOf service-instance, MANY2MANY)
  • TO service-subscription (PARENT of service-instance, service-instance BelongsTo service-subscription, MANY2ONE)

    • service-instance BelongsTo service-subscription(4)

  • TO vce( service-instance ComposedOf vce, ONE2MANY)
  • TO vlan( service-instance ComposedOf vlan, ONE2MANY)
  • TO vrf( service-instance ComposedOf vrf, MANY2MANY)

    • This edge relates a vrf that is configured on a pnf to the service-instances that the vrf supports.

  • TO zone( service-instance LocatedIn zone, MANY2ONE)
  • FROM allotted-resource (CHILD of service-instance, allotted-resource BelongsTo service-instance, MANY2ONE)(1)
  • FROM cloud-region( cloud-region Uses service-instance, MANY2MANY)
  • FROM communication-service-profile (CHILD of service-instance, communication-service-profile BelongsTo service-instance, ONE2ONE)
  • FROM composed-resource (CHILD of service-instance, composed-resource ComposedOf service-instance, MANY2ONE)(1)
  • FROM connectivity( connectivity PartOf service-instance, MANY2MANY)

    • For CCVPN Usecase

  • FROM device( device PartOf service-instance, ONE2MANY)

    • For CCVPN Usecase

  • FROM forwarding-path( forwarding-path AppliesTo service-instance, MANY2ONE)(1)
  • FROM lan-port-config( lan-port-config PartOf service-instance, ONE2MANY)

    • For CCVPN Usecase

  • FROM metadatum (CHILD of service-instance, metadatum BelongsTo service-instance, MANY2ONE)(1)
  • FROM project( project Uses service-instance, ONE2MANY)
  • FROM sdwan-vpn( sdwan-vpn PartOf service-instance, ONE2MANY)

    • For CCVPN Usecase

  • FROM service-instance( service-instance ComposedOf service-instance, MANY2MANY)
  • FROM service-profile (CHILD of service-instance, service-profile BelongsTo service-instance, ONE2ONE)
  • FROM site-resource( site-resource PartOf service-instance, MANY2MANY)

    • For CCVPN Usecase

  • FROM slice-profile (CHILD of service-instance, slice-profile BelongsTo service-instance, MANY2ONE)
  • FROM sp-partner( sp-partner PartOf service-instance, ONE2MANY)

    • For CCVPN Usecase

  • FROM wan-port-config( wan-port-config PartOf service-instance, MANY2MANY)

    • For CCVPN Usecase

  • FROM zone( zone Uses service-instance, MANY2MANY)

  • (1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
  • (2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
  • (4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
  • SERVICE-INSTANCE cannot be deleted if related to VRF
service-instance-id: string

Uniquely identifies this instance of a service

service-instance-name: string

This field will store a name assigned to the service-instance.

service-type: string

String capturing type of service.

service-role: string

String capturing the service role.

service-rate: string

Rate of the service instance.

service-layer: string

Definition of the service layer.

due-date: string

Due date of the service creation.

end-date: string

End date of the service creation.

environment-context: string

This field will store the environment context assigned to the service-instance.

workload-context: string

This field will store the workload context assigned to the service-instance.

created-at: string

create time of Network Service.

updated-at: string

last update of Network Service.

description: string

short description for service-instance.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

persona-model-version: string

the ASDC model version for this resource or service model.

widget-model-id: string

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

widget-model-version: string

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

bandwidth-total: string

Indicates the total bandwidth to be used for this service.

bandwidth-up-wan1: string

indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.

bandwidth-down-wan1: string

indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.

bandwidth-up-wan2: string

indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.

bandwidth-down-wan2: string

indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.

vhn-portal-url: string

URL customers will use to access the vHN Portal.

service-instance-location-id: string

An identifier that customers assign to the location where this service is being used.

selflink: string

Path to the controller object.

orchestration-status: string

Orchestration status of this service.

input-parameters: string

String capturing request parameters from SO to pass to Closed Loop.

service-function: string

String capturing function of the service.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

operational-status: string

Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.

relationship-list: object
relationship

zzzz-patch-service-profile: object

Requirement of E2E Slice service.

  • TO service-instance (PARENT of service-profile, service-profile BelongsTo service-instance, ONE2ONE)
profile-id: string

ID of the profile.

latency: integer

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.

max-number-of-UEs: integer

The maximum number of UEs may simultaneously access the E2E slice service

coverage-area-TA-list: string

A list of TrackingAreas where the NSI can be selected.

ue-mobility-level: string

User mobility level, value can be stationary, nomadic, restricted mobility, fully mobility.

resource-sharing-level: string

Whether the resources to be allocated to the network slice instance may be shared with another network slice instance(s).

activity-factor: integer

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.

jitter: integer

The jitter requirements of network slice.

survival-time: string

An attribute specifies the time that an application consuming a communication service may continue without an anticipated message.

reliability: string

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.

dl-thpt-per-slice: integer

This attribute defines achievable data rate of the network slice in downlink that is available ubiquitously across the coverage area of the slice.

dl-thpt-per-UE: integer

This attribute defines downlink data rate supported by the network slice per UE.

ul-thpt-per-slice: integer

This attribute defines achievable data rate of the network slice in uplink that is available ubiquitously across the coverage area of the slice.

ul-thpt-per-UE: integer

This attribute defines uplink data rate supported by the network slice per UE.

max-pkt-size: integer

This parameter specifies the maximum packet size supported by the network slice.

max-number-of-conns: integer

This parameter defines the maximum number of concurrent sessions supported by the network slice.

term-density: integer

An attribute specifies the overall user density over the coverage area of the network slice.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-service-subscription: object

Object that group service instances.

  • TO customer (PARENT of service-subscription, service-subscription BelongsTo customer, MANY2ONE)

    • service-subscription BelongsTo customer(4)

  • TO tenant( service-subscription Uses tenant, MANY2MANY)
  • FROM service-instance (CHILD of service-subscription, service-instance BelongsTo service-subscription, MANY2ONE)

    • service-instance BelongsTo service-subscription(1)

  • (1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
service-type: string

Value defined by orchestration to identify this service across ONAP.

temp-ub-sub-account-id: string

This property will be deleted from A&AI in the near future. Only stop gap solution.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-site-pair: object

  • TO routing-instance (PARENT of site-pair, site-pair BelongsTo routing-instance, MANY2ONE)(4)
  • FROM class-of-service (CHILD of site-pair, class-of-service BelongsTo site-pair, MANY2ONE)(1)

  • (1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this SITE-PAIR is DELETED also
site-pair-id: string

unique identifier of probe

source-ip: string

Prefix address

destination-ip: string

Prefix address

ip-version: string

ip version, v4, v6

destination-hostname: string

Hostname of the destination equipment to which SLAs are measured against.

destination-equip-type: string

The type of destinatination equipment. Could be Router, UCPE, etc.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-site-pair-set: object

Set of instances for probes used to measure service level agreements

  • TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
  • FROM routing-instance (CHILD of site-pair-set, routing-instance BelongsTo site-pair-set, MANY2ONE)(1)

  • (1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
site-pair-set-id: string

Unique id of site pair set.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-site-resource: object

Instance of a site-resource

  • TO allotted-resource( site-resource Uses allotted-resource, MANY2MANY)

    • For CCVPN Usecase

  • TO complex( site-resource Uses complex, MANY2MANY)

    • For CCVPN Usecase

  • TO ext-aai-network( site-resource BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • TO generic-vnf( site-resource PartOf generic-vnf, MANY2MANY)

    • For CCVPN Usecase

  • TO service-instance( site-resource PartOf service-instance, MANY2MANY)

    • For CCVPN Usecase

site-resource-id: string

Uniquely identifies this site-resource by id

site-resource-name: string

Store the name of this site-resource.

description: string

Store the description of this site-resource.

type: string

Store the type of this site-resource.

role: string

Store the role of this site-resource.

generated-site-id: string

Store the generated-site-id of this site-resource.

selflink: string

Store the link to get more information for this object.

operational-status: string

Store the operational-status for this object.

model-customization-id: string

Store the model-customization-id for this object.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-slice-profile: object

Requirement of network slice subnet service.

  • TO service-instance (PARENT of slice-profile, slice-profile BelongsTo service-instance, MANY2ONE)
profile-id: string

ID of the profile.

latency: integer

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.

max-number-of-UEs: integer

The maximum number of UEs may simultaneously access the slice subnet service

coverage-area-TA-list: string

A list of TrackingAreas where the NSSI can be selected.

ue-mobility-level: string

User mobility level, value can be stationary, nomadic, restricted mobility, fully mobility.

resource-sharing-level: string

Whether the resources to be allocated to the slice subnet instance may be shared with another network slice instance(s).

exp-data-rate-UL: integer

User experience data rate of upload.

exp-data-rate-DL: integer

User experience data rate of download.

area-traffic-cap-UL: integer

The area traffic capbility of upload.

area-traffic-cap-DL: integer

The area traffic capbility of download.

activity-factor: integer

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.

jitter: integer

The jitter requirements of network slice subnet.

survival-time: string

Survival time for network slice subnet.

max-bandwidth: integer

Maxmun bandwidth value of TN network.

exp-data-rate: integer

Expected date rate for uRLLC.

max-number-of-PDU-session: integer

maxNumberofPDUSession Integer 1 The maximum number of PDU sessions that can simultaneously/concurrently access to the network slice.

overall-user-density: integer

Overall User Density.

cs-reliability-mean-time: string

Communication service reliability mean time between failures.

msg-size-byte: string

Message size(byte) .

transfer-interval-target: string

transferIntervalTarget String 1 Target value of transfer interval.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-snapshot: object

Openstack snapshot

  • TO cloud-region (PARENT of snapshot, snapshot BelongsTo cloud-region, MANY2ONE)
  • FROM vserver( vserver Uses snapshot, ONE2ONE)
snapshot-id: string

Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

snapshot-name: string

Snapshot name

snapshot-architecture: string

Operating system architecture

snapshot-os-distro: string

The common name of the operating system distribution in lowercase

snapshot-os-version: string

The operating system version as specified by the distributor.

application: string

The application that the image instantiates.

application-vendor: string

The vendor of the application.

application-version: string

The version of the application.

snapshot-selflink: string

URL to endpoint where AAI can get more details

prev-snapshot-id: string

This field contains the UUID of the previous snapshot (if any).

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-software-version: object

Software Version

  • TO pnf (PARENT of software-version, software-version BelongsTo pnf, MANY2ONE)
software-version-id: string

Identifier of the software version

is-active-sw-ver: boolean

used to indicate whether or not this software-version is the active one (activeSw = true)

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

zzzz-patch-sp-partner: object

Instance of an sp-partner

  • TO service-instance( sp-partner PartOf service-instance, ONE2MANY)

    • For CCVPN Usecase

sp-partner-id: string

Uniquely identifies this sp-partner by id

url: string

Store the URL of this sp-partner.

callsource: string

Store the callsource of this sp-partner.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

operational-status: string

Store the operational-status for this sp-partner.

model-customization-id: string

Store the model-customization-id for this sp-partner.

model-invariant-id: string

the ASDC model id for this sp-partner model.

model-version-id: string

the ASDC model version for this sp-partner model.

relationship-list: object
relationship

zzzz-patch-sriov-pf: object

SR-IOV Physical Function

  • TO p-interface (PARENT of sriov-pf, sriov-pf BelongsTo p-interface, ONE2ONE)(4)
  • FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)

  • (4) IF this TO node is deleted, this SRIOV-PF is DELETED also
pf-pci-id: string

Identifier for the sriov-pf

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-sriov-vf: object

SR-IOV Virtual Function (not to be confused with virtual network function)

  • TO l-interface (PARENT of sriov-vf, sriov-vf BelongsTo l-interface, ONE2ONE)(4)
  • TO sriov-pf( sriov-vf Uses sriov-pf, MANY2ONE)

  • (4) IF this TO node is deleted, this SRIOV-VF is DELETED also
pci-id: string

PCI ID used to identify the sriov-vf

vf-vlan-filter: string

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

vf-mac-filter: string

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

vf-vlan-strip: boolean

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

vf-vlan-anti-spoof-check: boolean

This option ensures anti VLAN spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.

vf-mac-anti-spoof-check: boolean

This option ensures anti MAC spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.

vf-mirrors: string

This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.

vf-broadcast-allow: boolean

This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM

vf-unknown-multicast-allow: boolean

This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM

vf-unknown-unicast-allow: boolean

This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM

vf-insert-stag: boolean

This option, if set to true, instructs to insert outer tag after traffic comes out of VM.

vf-link-status: string

This option is used to set the link status. Valid values as of 1607 are on, off, and auto.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

neutron-network-id: string

Neutron network id of the interface

relationship-list: object
relationship

zzzz-patch-start-node-filter: object

property-name: string
property-value: string

zzzz-patch-subnet: object

  • TO l3-network (PARENT of subnet, subnet BelongsTo l3-network, MANY2ONE)(4)
  • TO zone (PARENT of subnet, subnet BelongsTo zone, MANY2ONE)

    • A fabric subnet belongs to a zone.(4)

  • FROM bgp-group( bgp-group Destination subnet, MANY2ONE)

    • To node-type is destination of bgp-group.

  • FROM bgp-group( bgp-group Source subnet, MANY2ONE)

    • To node-type is source of bgp-group.

  • FROM bgp-neighbor (CHILD of subnet, bgp-neighbor BelongsTo subnet, MANY2ONE)

    • bgp-neighbor belongs To a subnet.(1)

  • FROM configuration( configuration Uses subnet, ONE2MANY)

    • A configuration uses a subnet

  • FROM host-route (CHILD of subnet, host-route BelongsTo subnet, MANY2ONE)(1)
  • FROM ip-address-list (CHILD of subnet, ip-address-list BelongsTo subnet, MANY2ONE)(1)
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
  • FROM network-route( network-route MemberOf subnet, MANY2ONE)

    • The route is part of part of a subnet.

  • FROM profile( profile AppliesTo subnet, MANY2MANY)

    • A profile (set of characteristics) applies to the subnet.

  • FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
  • FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf subnet, MANY2MANY)

  • (1) IF this SUBNET node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this SUBNET is DELETED also
  • SUBNET cannot be deleted if related to BGP-GROUP,L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
subnet-id: string

Subnet ID, should be UUID.

subnet-name: string

Name associated with the subnet.

neutron-subnet-id: string

Neutron id of this subnet

gateway-address: string

gateway ip address

network-start-address: string

network start address

cidr-mask: string

cidr mask

ip-version: string

ip version

orchestration-status: string

Orchestration status of this VNF, mastered by MSO

description: string

text used for documentation

dhcp-enabled: boolean

dhcp enabled

dhcp-start: string

the start address reserved for use by dhcp

dhcp-end: string

the last address reserved for use by dhcp

subnet-role: string

role of the subnet, referenced when assigning IPs

subnet-model: string

subnet model BGP, VRPP

ops-note: string

Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.

subnet-type: string

Subtype used to categorize this physical link

subnet-function: string

The function performed by this Linterface

ip-assignment-direction: string

ip address assignment direction of the subnet

subnet-sequence: integer

sequence of the subnet

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

configuration-status: string

Configuration status of the subnet.

relationship-list: object
relationship

zzzz-patch-sw-component: object

create/update/delete the sw-component node

  • TO profile( sw-component AppliesTo profile, MANY2MANY)

    • The profile associated to a sw-component

  • FROM pnf( pnf MemberOf sw-component, MANY2ONE)

    • The sw-component associated to a pnf

  • FROM pserver( pserver MemberOf sw-component, MANY2ONE)

    • The sw-component associated to a pserver

  • FROM vserver( vserver MemberOf sw-component, MANY2ONE)

    • The sw-component associated to a vserver

sw-component-id: string

UUID

sw-component-name: string

Name of software component

sw-component-type: string

Type of software component

sw-component-role: string

Role of software component

sw-component-function: string

Function of software component

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-temporary-parameter-list: object

Used to specify temporary parameters for p-interface, lag-interface, or l-interface objects.

  • TO l-interface (PARENT of temporary-parameter-list, temporary-parameter-list BindsTo l-interface, MANY2ONE)

    • used for generic interface parameters(4)

  • TO lag-interface (PARENT of temporary-parameter-list, temporary-parameter-list BindsTo lag-interface, MANY2ONE)

    • used for generic interface parameters(4)

  • TO p-interface (PARENT of temporary-parameter-list, temporary-parameter-list BindsTo p-interface, MANY2ONE)

    • used for generic interface parameters(4)

  • (4) IF this TO node is deleted, this TEMPORARY-PARAMETER-LIST is DELETED also
temporary-parameter-list-id: string

UUID - unique object identifier

param-group: string

temporary parameter group

param-name: string

temporary parameter name

param-value: string

temporary parameter value

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-tenant: object

Openstack tenant

  • TO cloud-region (PARENT of tenant, tenant BelongsTo cloud-region, MANY2ONE)
  • TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
  • TO l3-network( tenant Uses l3-network, MANY2MANY)
  • TO volume-group( tenant DependsOn volume-group, ONE2MANY)
  • FROM generic-vnf( generic-vnf BelongsTo tenant, MANY2ONE)
  • FROM k8s-resource (CHILD of tenant, k8s-resource BelongsTo tenant, MANY2ONE)
  • FROM line-of-business( line-of-business Uses tenant, MANY2MANY)
  • FROM nos-server (CHILD of tenant, nos-server BelongsTo tenant, MANY2ONE)
  • FROM owning-entity( owning-entity Uses tenant, ONE2MANY)
  • FROM sdwan-vpn( sdwan-vpn PartOf tenant, ONE2MANY)

    • For CCVPN Usecase

  • FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
  • FROM vf-module( vf-module HostedOn tenant, MANY2ONE)
  • FROM vserver (CHILD of tenant, vserver BelongsTo tenant, MANY2ONE)

  • TENANT cannot be deleted if related to K8S-RESOURCE,NOS-SERVER,VSERVER
tenant-id: string

Unique id relative to the cloud-region.

tenant-name: string

Readable name of tenant

tenant-context: string

This field will store the tenant context.

parent-id: string

tenant parent-id

production-state: string

Production state

support-model: string

Support Model

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-tunnel-termination-point: object

Instance of an tunnel termination point

  • TO interlayer-attachment( tunnel-termination-point LinksTo interlayer-attachment, MANY2MANY)

    • For CCVPN Usecase(4)

  • TO pnf( tunnel-termination-point BindsTo pnf, MANY2MANY)

    • For CCVPN Usecase(4)

  • FROM p-interface( p-interface BindsTo tunnel-termination-point, MANY2MANY)

    • For CCVPN Usecase(1)

  • (1) IF this TUNNEL-TERMINATION-POINT node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this TUNNEL-TERMINATION-POINT is DELETED also
ttp-id: string

Id that identifies the tunnel termination point

tunnel-tp-id: string

TTP ID discovered from controller

name: string

Name of tunnel termination point

admin-status: string

Admin status of TTP e.g, up,down,testing,preparing-maintenance,maintenance.

oper-status: string

Operational status of TTP e.g, up,down,testing,preparing-maintenance,maintenance.

switching-capability: string

Indicate switching capability of TTP e.g,PSC-1, EVPL,L2SC,TDM,OTN.

encoding: string

Encoding support by the TTP e.g, packet,ethernet,PDH,SDH,digital-wrapper,lambda,fiber,ODUK,line.

protection-type: string

Indicate supported protection type of this TTP e.g, unprotected,reroute,reroute-extra,1-for-n,unidir-1-to-1.

inter-layer-lock-id: integer

correlation between related objects in ETH and OTN topology.

selflink: string

Store the link to get more information for this object.

operational-status: string

Store the operational-status for this object.

model-customization-id: string

Store the model-customization-id for this object.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-tunnel-xconnect: object

Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted

  • TO allotted-resource (PARENT of tunnel-xconnect, tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)

  • (4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
id: string

Allotted Resource id UUID assigned to this instance.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-uni: object

Instance of an User network interface

  • TO generic-vnf( uni PartOf generic-vnf, MANY2MANY)

    • For CCVPN Usecase

  • TO p-interface( uni PartOf p-interface, MANY2MANY)

    • For CCVPN Usecase

  • FROM connectivity( connectivity PartOf uni, MANY2MANY)

    • For CCVPN Usecase -- ETree

id: string

Id that identifies the UNI

tp-id: string

Termination point ID.

cvlan: string

The cvlan for the site used for ethernet type connectivity.

selflink: string

Store the link to get more information for this object.

operational-status: string

Store the operational-status for this object.

model-customization-id: string

Store the model-customization-id for this object.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-update: object

Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.

update-node-type: string
update-node-uri: string

zzzz-patch-update-node-key: object

key-name: string
key-value: string

zzzz-patch-validation-audit: object

validation audit, value of validation status

  • TO cloud-region (PARENT of validation-audit, validation-audit BelongsTo cloud-region, ONE2ONE)

    • The validation-audit associated to a cloud-region(4)

  • TO line-of-business( validation-audit AppliesTo line-of-business, MANY2ONE)

    • The line-of-business associated to a validation-audit

  • (4) IF this TO node is deleted, this VALIDATION-AUDIT is DELETED also
validation-id: string

Validation-Audit UUID

validation-request-id: string

Request-id to retrieve data from client related to the specified audit

validation-status: string

Status of the audit

validation-phase: string

Phase in the lifecycle of the configuration

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-vce: object

Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.

  • TO availability-zone( vce Uses availability-zone, MANY2MANY)
  • TO complex( vce LocatedIn complex, MANY2MANY)
  • TO vserver( vce HostedOn vserver, ONE2MANY)
  • FROM entitlement (CHILD of vce, entitlement BelongsTo vce, MANY2ONE)(1)
  • FROM license (CHILD of vce, license BelongsTo vce, MANY2ONE)(1)
  • FROM port-group (CHILD of vce, port-group BelongsTo vce, MANY2ONE)(1)
  • FROM service-instance( service-instance ComposedOf vce, ONE2MANY)

  • (1) IF this VCE node is deleted, this FROM node is DELETED also
vnf-id: string

Unique id of VNF. This is unique across the graph.

vnf-name: string

Name of VNF.

vnf-name2: string

Alternate name of VNF.

vnf-type: string

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.

service-id: string

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

regional-resource-zone: string

Regional way of organizing pservers, source of truth should define values

prov-status: string

Trigger for operational monitoring of this resource by Service Assurance systems.

operational-status: string

Indicator for whether the resource is considered operational

license-key: string

OBSOLETE - do not use

equipment-role: string

Network role being played by this VNF

orchestration-status: string

Orchestration status of this VNF, mastered by MSO

heat-stack-id: string

Heat stack id corresponding to this instance, managed by MSO

mso-catalog-key: string

Corresponds to the SDN-C catalog id used to configure this VCE

vpe-id: string

Unique ID of VPE connected to this VCE.

v6-vce-wan-address: string

Valid v6 IP address for the WAN Link on this router. Implied length of /64.

ipv4-oam-address: string

Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.

ipv4-loopback0-address: string

Loopback0 address

entitlement-resource-uuid: string

OBSOLETE - see child relationships

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-vf-module: object

a deployment unit of VNFCs

  • TO generic-vnf (PARENT of vf-module, vf-module BelongsTo generic-vnf, MANY2ONE)(4)
  • TO k8s-resource( vf-module Uses k8s-resource, ONE2MANY)
  • TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
  • TO tenant( vf-module HostedOn tenant, MANY2ONE)
  • TO vnfc( vf-module Uses vnfc, ONE2MANY)(2)
  • TO volume-group( vf-module Uses volume-group, ONE2ONE)
  • TO vserver( vf-module Uses vserver, ONE2MANY)

  • (2) IF this VF-MODULE node is deleted, this TO node is DELETED also
  • (4) IF this TO node is deleted, this VF-MODULE is DELETED also
vf-module-id: string

Unique ID of vf-module.

vf-module-name: string

Name of vf-module

heat-stack-id: string

Heat stack id corresponding to this instance.

orchestration-status: string

orchestration status of this vf-module, mastered by MSO

is-base-vf-module: boolean

used to indicate whether or not this object is base vf module

automated-assignment: boolean

Indicates whether vf-module assignment was done via automation or manually

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

persona-model-version: string

the ASDC model version for this resource or service model.

model-customization-id: string

captures the id of all the configuration used to customize the resource for the service.

widget-model-id: string

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

widget-model-version: string

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

contrail-service-instance-fqdn: string

the Contrail unique ID for a service-instance

module-index: integer

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

selflink: string

Path to the controller object.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

operational-status: string

Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.

relationship-list: object
relationship

zzzz-patch-vig-server: object

vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607

  • TO ipsec-configuration (PARENT of vig-server, vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)

  • (4) IF this TO node is deleted, this VIG-SERVER is DELETED also
vig-address-type: string

indicates whether the VIG is for AVPN or INTERNET

ipaddress-v4-vig: string

v4 IP of the vig server

ipaddress-v6-vig: string

v6 IP of the vig server

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-vip-ipv4-address-list: object

IPv4 Address Range

  • TO cloud-region (PARENT of vip-ipv4-address-list, vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
  • TO cp( vip-ipv4-address-list Uses cp, MANY2MANY)
  • TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
  • TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
  • FROM bgp-group( bgp-group Destination vip-ipv4-address-list, MANY2ONE)

    • To node-type is destination of bgp-group.

  • FROM bgp-group( bgp-group Source vip-ipv4-address-list, MANY2ONE)

    • To node-type is source of bgp-group.

  • FROM bgp-neighbor( bgp-neighbor Uses vip-ipv4-address-list, MANY2ONE)

    • bgp-neighbor uses To node-type.

  • FROM fqdn( fqdn AppliesTo vip-ipv4-address-list, ONE2ONE)

    • The fqdn that applies to a vip-ipv4-address-list.

  • FROM ip-address-list( ip-address-list Uses vip-ipv4-address-list, ONE2ONE)

    • 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

  • FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)

  • VIP-IPV4-ADDRESS-LIST cannot be deleted if related to BGP-GROUP,BGP-NEIGHBOR,IP-ADDRESS-LIST
vip-ipv4-address: string

IP address

vip-ipv4-prefix-length: integer

Prefix length, 32 for single address

vlan-id-inner: integer

Inner VLAN tag

vlan-id-outer: integer

Outer VLAN tag

is-floating: boolean

Indicator of fixed or floating address

neutron-network-id: string

Neutron network id of the interface that address belongs to

neutron-subnet-id: string

Neutron id of subnet that address belongs to

ops-note: string

Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-vip-ipv6-address-list: object

IPv6 Address Range

  • TO cloud-region (PARENT of vip-ipv6-address-list, vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
  • TO cp( vip-ipv6-address-list Uses cp, MANY2MANY)
  • TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
  • TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
  • FROM bgp-group( bgp-group Destination vip-ipv6-address-list, MANY2ONE)

    • To node-type is destination of bgp-group.

  • FROM bgp-group( bgp-group Source vip-ipv6-address-list, MANY2ONE)

    • To node-type is source of bgp-group.

  • FROM bgp-neighbor( bgp-neighbor Uses vip-ipv6-address-list, MANY2ONE)

    • bgp-neighbor uses To node-type.

  • FROM fqdn( fqdn AppliesTo vip-ipv6-address-list, ONE2ONE)

    • The fqdn that applies to a vip-ipv6-address-list.

  • FROM ip-address-list( ip-address-list Uses vip-ipv6-address-list, ONE2ONE)

    • 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

  • FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)

  • VIP-IPV6-ADDRESS-LIST cannot be deleted if related to BGP-GROUP,BGP-NEIGHBOR,IP-ADDRESS-LIST
vip-ipv6-address: string

IP address

vip-ipv6-prefix-length: integer

Prefix length, 128 for single address

vlan-id-inner: integer

Inner VLAN tag

vlan-id-outer: integer

Outer VLAN tag

is-floating: boolean

Indicator of fixed or floating address

neutron-network-id: string

Neutron network id of the interface that address belongs to

neutron-subnet-id: string

Neutron id of subnet that address belongs to

ops-note: string

Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-virtual-data-center: object

Virtual organization of cloud infrastructure elements in a data center context

  • FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
  • FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
  • FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
vdc-id: string

Unique ID of the vdc

vdc-name: string

Name of the virtual data center

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-vlan: object

Definition of vlan

  • TO l-interface (PARENT of vlan, vlan LinksTo l-interface, MANY2ONE)(4)
  • TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
  • TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
  • FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
  • FROM l3-interface-ipv4-address-list (CHILD of vlan, l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
  • FROM l3-interface-ipv6-address-list (CHILD of vlan, l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
  • FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)

  • (1) IF this VLAN node is deleted, this FROM node is DELETED also
  • (2) IF this VLAN node is deleted, this TO node is DELETED also
  • (4) IF this TO node is deleted, this VLAN is DELETED also
vlan-interface: string

String that identifies the interface

vlan-id-inner: integer

Inner VLAN tag

vlan-id-outer: integer

Outer VLAN tag

speed-value: string

Captures the numeric part of the speed

speed-units: string

Captures the units corresponding to the speed

vlan-type: string

The type of vlan (eg. vxlan)

vlan-description: string

Used to describe (the service associated with) the vlan

backdoor-connection: string

Whether customer is going to use this VLAN for backdoor connection to another customer premise device.

vpn-key: string

This indicates the customers VPN ID associated with this vlan

orchestration-status: string

Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.

in-maint: boolean

used to indicate whether or not this object is in maintenance mode (maintenance mode = true)

prov-status: string

Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].

is-ip-unnumbered: boolean

Flag indicating the interface uses the IP Unnumbered configuration.

is-private: boolean

Private VLAN indicator.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-vlan-characteristic: object

describes an vlan characteristic

  • TO vlan-tag( vlan-characteristic AppliesTo vlan-tag, MANY2MANY)
vlan-characteristic-id: string

UUID.

root-name: string

Name.

applies-to: string

Device role the vlan-characteristic applies to (c-agg-leaf-a, c-agg-leaf-b, r-leaf).

dhcp-pool: boolean

DHCP Agent access.

internet-access: boolean

Boolean to represent if requires internet access.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-vlan-mapping: object

vlan-mapping object is an optional child object of the forwarder-evc object. A given forwarder-evc object may have multiple vlan-mapping objects.

  • TO forwarder-evc (PARENT of vlan-mapping, vlan-mapping BelongsTo forwarder-evc, MANY2ONE)(4)

  • (4) IF this TO node is deleted, this VLAN-MAPPING is DELETED also
vlan-mapping-id: string

Key for vlan-mapping object.

uni-cvlan: string

CVLAN value from the UNI/ingress side of the SAREA gateway access device.

nni-svlan: string

SVLAN value from the NNI/egress side of the SAREA gateway access device.

nni-cvlan: string

CVLAN value from the NNI/egress side of the SAREA gateway access device.

ivlan: string

The internal VLAN ('IVLAN') value. Specific to Arista devices.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-vlan-range: object

Definition of vlan range

  • TO cloud-region (PARENT of vlan-range, vlan-range BelongsTo cloud-region, MANY2ONE)

    • A vlan range belongs to a cloud-region.(4)

  • TO zone (PARENT of vlan-range, vlan-range BelongsTo zone, MANY2ONE)

    • The vlan-range is located in a zone.(4)

  • FROM line-of-business( line-of-business Uses vlan-range, ONE2MANY)

    • A line-of uses a vlan-range

  • FROM owning-entity( owning-entity Uses vlan-range, ONE2MANY)

    • An owning-entity uses a vlan-range.

  • FROM profile( profile AppliesTo vlan-range, MANY2MANY)

    • A profile (set of characteristics) applies to the vlan-range.

  • FROM vlan-tag (CHILD of vlan-range, vlan-tag BelongsTo vlan-range, MANY2ONE)

    • A vlan-tag belongs to a vlan-range.(1)

  • (1) IF this VLAN-RANGE node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this VLAN-RANGE is DELETED also
vlan-range-id: string

vlan id in range UUID.

vlan-id-lower: integer

vlan id in range lower

vlan-id-upper: integer

vlan id in range upper

vlan-type: string

vlan type

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-vlan-tag: object

vlan tag information

  • TO cloud-region( vlan-tag BelongsTo cloud-region, MANY2ONE)
  • TO cp( vlan-tag Uses cp, MANY2MANY)
  • TO vlan-range (PARENT of vlan-tag, vlan-tag BelongsTo vlan-range, MANY2ONE)

    • A vlan-tag belongs to a vlan-range.(4)

  • FROM l-interface( l-interface Uses vlan-tag, MANY2MANY)

    • An sub-interface that uses a vlan-tag.

  • FROM l3-network( l3-network Uses vlan-tag, MANY2MANY)

    • A l3-network Uses vlan-tag.

  • FROM policy( policy AppliesTo vlan-tag, MANY2MANY)

    • 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.

  • FROM profile( profile AppliesTo vlan-tag, MANY2MANY)

    • A profile (set of characteristics) applies to the vlan-tag.

  • FROM vlan-characteristic( vlan-characteristic AppliesTo vlan-tag, MANY2MANY)

  • (4) IF this TO node is deleted, this VLAN-TAG is DELETED also
  • VLAN-TAG cannot be deleted if related to L-INTERFACE
vlan-tag-id: string

Vlan Tag Id

vlan-tag-role: string

Role assigned to this vlan-tag

vlan-id-inner: integer

Inner VLAN tag

vlan-id-outer: integer

Outer VLAN tag

is-private: boolean

is private flag.

vlan-tag-type: string

VLAN tag Type

vlan-tag-function: string

VLAN Tag Function

config-phase: string

The config-phase associated with this vlan-tag

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-vnf: object

Abstract vnf class

vnf-id: string

Unique id of VNF. This is unique across the graph.

zzzz-patch-vnf-image: object

Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.

  • FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)

  • VNF-IMAGE cannot be deleted if related to GENERIC-VNF
vnf-image-uuid: string

Unique ID of this asset

application: string

The application that the image instantiates.

application-vendor: string

The vendor of the application.

application-version: string

The version of the application.

selflink: string

URL to endpoint where AAI can get more details

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-vnfc: object

  • TO cp (PARENT of vnfc, vnfc BelongsTo cp, ONE2MANY)

    • cp is child of vnfc(2)

  • TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
  • TO instance-group( vnfc MemberOf instance-group, MANY2MANY)
  • TO vip-ipv4-address-list( vnfc Uses vip-ipv4-address-list, MANY2MANY)
  • TO vip-ipv6-address-list( vnfc Uses vip-ipv6-address-list, MANY2MANY)
  • TO vserver( vnfc HostedOn vserver, ONE2MANY)
  • FROM configuration( configuration Uses vnfc, ONE2ONE)(1)
  • FROM l3-interface-ipv4-address-list (CHILD of vnfc, l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(1)
  • FROM l3-interface-ipv6-address-list (CHILD of vnfc, l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(1)
  • FROM vf-module( vf-module Uses vnfc, ONE2MANY)(3)

  • (1) IF this VNFC node is deleted, this FROM node is DELETED also
  • (2) IF this VNFC node is deleted, this TO node is DELETED also
  • (3) IF this FROM node is deleted, this VNFC is DELETED also
  • (4) IF this TO node is deleted, this VNFC is DELETED also
vnfc-name: string

Unique ID of vnfc.

nfc-naming-code: string

Short code that is used in naming instances of the item being modeled

nfc-function: string

English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service

prov-status: string

prov status of this vnfc

orchestration-status: string

Orchestration status of this VNF, mastered by APP-C

ipaddress-v4-oam-vip: string

Oam V4 vip address of this vnfc

in-maint: boolean

used to indicate whether or not this object is in maintenance mode (maintenance mode = true)

is-closed-loop-disabled: boolean

used to indicate whether closed loop function is enabled on this node

group-notation: string

Group notation of VNFC

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

model-customization-id: string

captures the id of all the configuration used to customize the resource for the service.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-volume: object

Ephemeral Block storage volume.

  • FROM vserver (PARENT of volume, vserver AttachesTo volume, ONE2MANY)(3)

  • (3) IF this FROM node is deleted, this VOLUME is DELETED also
volume-id: string

Unique ID of block storage volume relative to the vserver.

volume-selflink: string

URL to endpoint where AAI can get more details

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-volume-group: object

Persistent block-level storage.

  • TO cloud-region (PARENT of volume-group, volume-group BelongsTo cloud-region, MANY2ONE)
  • TO complex( volume-group LocatedIn complex, MANY2ONE)
  • FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
  • FROM tenant( tenant DependsOn volume-group, ONE2MANY)
  • FROM vf-module( vf-module Uses volume-group, ONE2ONE)
volume-group-id: string

Unique ID of volume-group.

volume-group-name: string

Name of the volume group.

heat-stack-id: string

Heat stack id corresponding to this volume-group

vnf-type: string

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: string

Orchestration status of this volume-group

model-customization-id: string

captures the id of all the configuration used to customize the resource for the service.

vf-module-model-customization-id: string

helps relate the volume group to the vf-module whose components will require the volume group

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-vpls-pe: object

VPLS Provider Edge routers.

  • TO complex( vpls-pe LocatedIn complex, MANY2ONE)
  • TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
  • FROM lag-interface (CHILD of vpls-pe, lag-interface BindsTo vpls-pe, MANY2ONE)(1)
  • FROM p-interface (CHILD of vpls-pe, p-interface BindsTo vpls-pe, MANY2ONE)(1)

  • (1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
equipment-name: string
prov-status: string

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

ipv4-oam-address: string

Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).

equipment-role: string

Client should send valid enumerated value, e.g., VPLS-PE.

vlan-id-outer: integer

Temporary location for stag to get to VCE

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-vpn-binding: object

VPN binding

  • TO aggregate-route( vpn-binding Uses aggregate-route, ONE2MANY)

    • A vpn-binding uses many aggregate routes

  • TO customer( vpn-binding Uses customer, MANY2MANY)
  • TO ext-aai-network( vpn-binding BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • TO p-interface( vpn-binding BindsTo p-interface, ONE2MANY)

    • For CCVPN Usecase

  • FROM allotted-resource( allotted-resource BelongsTo vpn-binding, MANY2MANY)
  • FROM configuration( configuration Uses vpn-binding, MANY2ONE)
  • FROM connectivity( connectivity BindsTo vpn-binding, MANY2MANY)

    • For CCVPN Usecase

  • FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
  • FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
  • FROM network-resource( network-resource Uses vpn-binding, ONE2MANY)

    • For CCVPN Usecase

  • FROM policy( policy Uses vpn-binding, ONE2MANY)

    • A policy uses vpn-bindings

  • FROM profile( profile AppliesTo vpn-binding, MANY2MANY)

    • A profile (set of characteristics) applies to the vpn-binding.

  • FROM route-target (CHILD of vpn-binding, route-target BelongsTo vpn-binding, MANY2ONE)(1)
  • FROM sdwan-vpn( sdwan-vpn PartOf vpn-binding, ONE2MANY)

    • For CCVPN Usecase

  • FROM vrf( vrf AppliesTo vpn-binding, MANY2ONE)

    • A vrf uses a vpn-binding.

  • (1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also
  • VPN-BINDING cannot be deleted if related to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
vpn-id: string

VPN ID, globally unique within A&AI

vpn-name: string

VPN Name

vpn-platform: string

the platform associated with the VPN example AVPN, Mobility

vpn-type: string

Type of the vpn, should be taken from enumerated/valid values

vpn-region: string

region of customer vpn

customer-vpn-id: string

id for this customer vpn

route-distinguisher: string

Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.

access-provider-id: string

Store the id of the access provider of this vpn.

access-client-id: string

Store the id of the access client of this vpn.

access-topology-id: string

Store the id of the access topology of this vpn.

src-access-node-id: string

Store the id of the src-access-node of this vpn.

src-access-ltp-id: string

Store the id of the src-access-ltp of this vpn.

dst-access-node-id: string

Store the id of the dst-access-node of this vpn.

dst-access-ltp-id: string

Store the id of the dst-access-ltp of this vpn.

operational-status: string

Store the operational-status of this vpn service.

admin-status: string

Store the admin-status of this vpn service.

protection-type: string

Store the protection-type of this vpn service.

slice-id: string

Store the ID of the transport slice to which this vpn service may belong.

switching-type: string

Store the type of multiplexing used for this vpn service.

src-tpn: string

Store source tributary port number of the underlay OTN tunnel realizing this vpn service.

dst-tpn: string

Store destination tributary port number of the underlay OTN tunnel realizing this vpn service.

model-customization-id: string

Store the model-customization-id for this object.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

max-prefix-v4: integer

Max prefix for IPv4.

max-prefix-v6: integer

Max prefix for IPv6.

max-prefix-threshold: integer

Max prefix threshold.

label-mode-v4: string

Label mode for IPv4.

label-mode-v6: string

Label mode for IPv6.

vpn-description: string

The description of the vpn.

vxlan-network-id: string

A VNI associated with the VPN.

ops-note: string

Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.

max-path: string

A variable BGP max AS path length.

max-paths-v4: integer

stores maximum number of paths for IPv4.

max-paths-v6: integer

stores maximum number of paths for IPv6.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-vrf: object

Definition of vrf

  • TO instance-group( vrf Primary instance-group, MANY2MANY)

    • used for vrf fallback

  • TO instance-group( vrf Secondary instance-group, MANY2MANY)

    • used for vrf fallback

  • TO l-interface( vrf Uses l-interface, ONE2MANY)
  • TO l3-network( vrf Uses l3-network, ONE2MANY)

    • A vrf uses many l3-networks

  • TO network-route( vrf Uses network-route, MANY2MANY)

    • Relates vrf to network-route for static routes.

  • TO next-hop( vrf Uses next-hop, MANY2MANY)

    • The vrfs that are used by the next-hop.

  • TO pnf (PARENT of vrf, vrf BelongsTo pnf, MANY2ONE)

    • A vrf belongs to a pnf.(4)

  • TO vpn-binding( vrf AppliesTo vpn-binding, MANY2ONE)

    • A vrf uses a vpn-binding.

  • FROM aggregate-route (CHILD of vrf, aggregate-route BelongsTo vrf, MANY2ONE)

    • An aggregate-route BelongsTo a vrf.(1)

  • FROM bgp-group (CHILD of vrf, bgp-group BelongsTo vrf, MANY2ONE)

    • A bgp-group belongs to a pnf.(1)

  • FROM bgp-neighbor (CHILD of vrf, bgp-neighbor BelongsTo vrf, MANY2ONE)

    • A bgp-neighbor belongs to a vrf.(1)

  • FROM configuration( configuration Uses vrf, MANY2MANY)

    • A Configuration uses VRFs

  • FROM object-group( object-group AppliesTo vrf, MANY2MANY)

    • The object-group to VRF for various route types.

  • FROM policy( policy AppliesTo vrf, MANY2MANY)
  • FROM profile( profile AppliesTo vrf, MANY2MANY)

    • A profile (set of characteristics) applies to the vrf.

  • FROM route-target (CHILD of vrf, route-target BelongsTo vrf, MANY2ONE)(1)
  • FROM service-instance( service-instance ComposedOf vrf, MANY2MANY)

    • This edge relates a vrf that is configured on a pnf to the service-instances that the vrf supports.

  • (1) IF this VRF node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this VRF is DELETED also
  • VRF cannot be deleted if related to INSTANCE-GROUP,NETWORK-ROUTE
vrf-id: string

VRF UUID.

vrf-name: string

VRF Name

vrf-description: string

VRF Description

route-distinguisher: string

Route Distinguisher

vrf-type: string

The type of vrf (bridge-domain as an example)

vrf-address-family: string

IP address family (v6/v4/both)

ops-note: string

Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.

vrf-role: string

Indicator for the use of this physical link

vrf-function: string

The function performed by this Linterface

vrf-group-name: string

Bridge domain group name

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

best-external: string

Identifies best-external vrf, best-external=Y if the conditions are met. otherwise, best-external = N

max-prefix-v4: integer

Max prefix for IPv4.

max-prefix-v6: integer

Max prefix for IPv6.

max-prefix-threshold-v4: integer

Max prefix threshold for IPv4.

max-prefix-threshold-v6: integer

Max prefix threshold for IPv6.

label-mode-v4: string

Label mode for IPv4.

label-mode-v6: string

Label mode for IPv6.

max-paths-v4: integer

stores maximum number of paths for IPv4.

max-paths-v6: integer

stores maximum number of paths for IPv6.

v4-max-path-type: string

Type of v4-max-path

v6-max-path-type: string

Type of v6-max-path

configuration-status: string

Configuration status of the vrf

relationship-list: object
relationship

zzzz-patch-vserver: object

Virtual Servers, aka virtual machine or VM.

  • TO flavor( vserver Uses flavor, MANY2ONE)
  • TO image( vserver Uses image, MANY2ONE)
  • TO instance-group( vserver MemberOf instance-group, MANY2MANY)
  • TO pserver( vserver HostedOn pserver, MANY2ONE)
  • TO snapshot( vserver Uses snapshot, ONE2ONE)
  • TO sw-component( vserver MemberOf sw-component, MANY2ONE)

    • The sw-component associated to a vserver

  • TO tenant (PARENT of vserver, vserver BelongsTo tenant, MANY2ONE)
  • TO volume (PARENT of vserver, vserver AttachesTo volume, ONE2MANY)(2)
  • FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
  • FROM l-interface (CHILD of vserver, l-interface BindsTo vserver, MANY2ONE)(1)
  • FROM profile( profile supports vserver, MANY2MANY)
  • FROM vce( vce HostedOn vserver, ONE2MANY)
  • FROM vf-module( vf-module Uses vserver, ONE2MANY)
  • FROM vnfc( vnfc HostedOn vserver, ONE2MANY)

  • (1) IF this VSERVER node is deleted, this FROM node is DELETED also
  • (2) IF this VSERVER node is deleted, this TO node is DELETED also
vserver-id: string

Unique identifier for this vserver relative to its tenant

vserver-name: string

Name of vserver

vserver-name2: string

Alternative name of vserver

prov-status: string

Trigger for operational monitoring of this resource by Service Assurance systems.

vserver-selflink: string

URL to endpoint where AAI can get more details

in-maint: boolean

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.

is-closed-loop-disabled: boolean

Used to indicate whether closed loop function is enabled on this node

numa: string

Non-uniform memory access optimization, helps prevent memory-bandwidth bottlenecks. Expected values - 1 or 2 identifying memory access

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

operational-status: string

Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.

relationship-list: object
relationship

zzzz-patch-wan-port-config: object

Instance of a wan-port-config

  • TO ext-aai-network( wan-port-config BelongsTo ext-aai-network, MANY2MANY)

    • For CCVPN Usecase

  • TO generic-vnf( wan-port-config PartOf generic-vnf, MANY2MANY)

    • For CCVPN Usecase

  • TO service-instance( wan-port-config PartOf service-instance, MANY2MANY)

    • For CCVPN Usecase

wan-port-config-id: string

Uniquely identifies this wan-port-config by id

wan-port-config-name: string

Store the name of this wan-port-config.

device-id: string

Store the id of the device of this wan-port-config.

vlan-id: string

Store the id of the vlan of this wan-port-config.

ip-address: string

Store the ip-address of this wan-port-config.

ipv4-address: string

Store the ipv4-address of this wan-port-config.

ipv6-address: string

Store the ipv6-address of this wan-port-config.

provider-ip-address: string

Store the provider-ip-address of this wan-port-config.

provider-ipv4-address: string

Store the provider-ipv4-address of this wan-port-config.

provider-ipv6-address: string

Store the provider-ipv6-address of this wan-port-config.

input-bandwidth: string

Store the input-bandwidth of this wan-port-config.

output-bandwidth: string

Store the output-bandwidth of this wan-port-config.

description: string

Store the description of this wan-port-config.

port-type: string

Store the port-type of this wan-port-config.

port-number: string

Store the port-number of this wan-port-config.

transport-network-name: string

Store the transport-network-name of this wan-port-config.

device-port-id: string

Store the device-port-id of this wan-port-config.

wan-port-id: string

Store the wan-port-id of this wan-port-config.

selflink: string

Store the link to get more information for this object.

operational-status: string

Store the operational-status for this object.

model-customization-id: string

Store the model-customization-id for this object.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

relationship-list: object
relationship

zzzz-patch-zone: object

A zone is a grouping of assets in a location homing to the same connections into the CBB

  • TO complex( zone LocatedIn complex, MANY2ONE)
  • TO endpoint( zone Uses endpoint, MANY2MANY)
  • TO service-instance( zone Uses service-instance, MANY2MANY)
  • TO zone( zone AppliesTo zone, MANY2MANY)

    • the zone is associated to another zone.

  • FROM autonomous-system( autonomous-system LocatedIn zone, MANY2ONE)

    • A local autonomous-system is located in a zone.(1)

  • FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
  • FROM contact( contact Supports zone, ONE2MANY)

    • The contact supports a zone.

  • FROM network-range( network-range LocatedIn zone, MANY2MANY)

    • The network-range is located in a zone

  • FROM object-group( object-group LocatedIn zone, MANY2MANY)

    • The object-group is located in a zone

  • FROM pnf( pnf LocatedIn zone, MANY2ONE)
  • FROM pserver( pserver LocatedIn zone, MANY2ONE)
  • FROM service-instance( service-instance LocatedIn zone, MANY2ONE)
  • FROM subnet (CHILD of zone, subnet BelongsTo zone, MANY2ONE)

    • A fabric subnet belongs to a zone.(1)

  • FROM vlan-range (CHILD of zone, vlan-range BelongsTo zone, MANY2ONE)

    • The vlan-range is located in a zone.(1)

  • FROM zone( zone AppliesTo zone, MANY2MANY)

    • the zone is associated to another zone.

  • (1) IF this ZONE node is deleted, this FROM node is DELETED also
  • ZONE cannot be deleted if related to ENDPOINT
zone-id: string

Code assigned by AIC to the zone

zone-name: string

English name associated with the zone

zone-type: string

The type of zone (ex. AIC or NC).

design-type: string

Design of zone [Medium/Large]

zone-context: string

Context of zone [production/test]

status: string

Status of a zone.

zone-role: string

Role of a zone.

zone-function: string

Function of a zone.

zone-number: integer

Zone number identifier for multi-zone locations.

data-owner: string

Identifies the entity that is responsible managing this inventory object.

data-source: string

Identifies the upstream source of the data.

data-source-version: string

Identifies the version of the upstream source.

in-maint: boolean

Used to indicate whether or not zone object is in maintenance mode.

relationship-list: object
relationship