Active and Available Inventory REST API.

Version: v11

Copyright © 2017 AT&T Intellectual Property. All rights reserved.

Licensed under the Creative Commons License, Attribution 4.0 Intl. (the "License"); you may not use this documentation except in compliance with the License.

You may obtain a copy of the License at

(https://creativecommons.org/licenses/by/4.0/)

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

ECOMP and OpenECOMP are trademarks and service marks of AT&T Intellectual Property.

This document is best viewed with Firefox or Chrome. Nodes can be found by appending /#/definitions/node-type-to-find to the path to this document. Edge definitions can be found with the node definitions.

Schemes: https

Summary

Tag: CloudInfrastructure

Operation Description
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
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}/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
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
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
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
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}

delete an existing flavor
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
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}/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
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
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
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
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
DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}

delete an existing tenant
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
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
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
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
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
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
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}/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
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
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
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
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}/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
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
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}/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
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
DELETE /cloud-infrastructure/complexes/complex/{physical-location-id}

delete an existing complex
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
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
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/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
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/pservers

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

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

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

delete an existing pserver
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
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}/l-interfaces

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

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

create or update an existing l-interface
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/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/{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/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

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

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

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

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

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

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

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

delete an existing relationship
PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/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/{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/{interface-name}/sriov-vfs

returns sriov-vfs
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/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/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

create or update an existing sriov-vf
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/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/{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/{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/{interface-name}/vlans

returns vlans
GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/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/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/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/{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/{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
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

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

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

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

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

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

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

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

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

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}/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
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}/l-interfaces

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

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

create or update an existing l-interface
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/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/{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/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

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

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

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

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

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

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

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

delete an existing relationship
PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/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/{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/{interface-name}/sriov-vfs

returns sriov-vfs
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/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/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

create or update an existing sriov-vf
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/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/{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/{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/{interface-name}/vlans

returns vlans
GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/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/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/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/{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/{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
DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

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

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

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

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

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

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

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

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

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
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
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
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

Operation Description
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
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
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-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
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
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
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
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

Operation Description
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
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
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
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
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
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
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/{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/{id}

create or 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/{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/{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/{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
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/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
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
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
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
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

Tag: ServiceDesignAndCreation

Operation Description
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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

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

delete an existing generic-vnf
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
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
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
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
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
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
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}/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
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
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
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
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}/l-interfaces

returns l-interfaces
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/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/{interface-name}

create or update an existing l-interface
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/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/{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/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or 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/{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/{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/{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/{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/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or 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/{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/{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/{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}/l-interfaces/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/{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/{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/{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/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

create or update an existing sriov-vf
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

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

see node definition for valid relationships
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

delete an existing relationship
GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/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/{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/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/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/{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/{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
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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/{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/{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/{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/{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
DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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/{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/{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/{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/{interface-name}/vlans/vlan/{vlan-interface}/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}/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
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
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/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
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/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
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
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
DELETE /network/l3-networks/l3-network/{network-id}

delete an existing l3-network
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
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
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
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}/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
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
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/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
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/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
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/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
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
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/newvces

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

returns newvce
PUT /network/newvces/newvce/{vnf-id2}

create or 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
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
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
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
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
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}/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
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
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
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/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
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
DELETE /network/pnfs/pnf/{pnf-name}

delete an existing pnf
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
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}/l-interfaces

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

returns l-interface
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

create or update an existing l-interface
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/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/{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/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

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

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

create or update an existing l3-interface-ipv6-address-list
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/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/{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/{interface-name}/sriov-vfs

returns sriov-vfs
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/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/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

create or update an existing sriov-vf
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/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/{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/{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/{interface-name}/vlans

returns vlans
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/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/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/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/{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/{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
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

create or update an existing l3-interface-ipv6-address-list
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

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

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

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}/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
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}/l-interfaces

returns l-interfaces
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

returns l-interface
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

create or update an existing l-interface
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/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/{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/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

create or update an existing l3-interface-ipv6-address-list
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/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/{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/{interface-name}/sriov-vfs

returns sriov-vfs
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/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/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

create or update an existing sriov-vf
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/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/{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/{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/{interface-name}/vlans

returns vlans
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/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/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/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/{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/{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
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship
GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

create or update an existing l3-interface-ipv6-address-list
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

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

see node definition for valid relationships
DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

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

returns vces
GET /network/vces/vce/{vnf-id}

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

create or 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
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
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
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
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
DELETE /network/vnfcs/vnfc/{vnfc-name}

delete an existing vnfc
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
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
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
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
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}/l-interfaces

returns l-interfaces
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/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/{interface-name}

create or update an existing l-interface
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/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/{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/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or 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/{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/{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/{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/{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/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or 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/{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/{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/{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}/l-interfaces/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/{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/{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/{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/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

create or update an existing sriov-vf
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

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

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

delete an existing relationship
GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/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/{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/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/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/{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/{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
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

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/{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/{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/{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/{interface-name}/vlans/vlan/{vlan-interface}/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}/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
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}/l-interfaces

returns l-interfaces
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/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/{interface-name}

create or update an existing l-interface
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/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/{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/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or 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/{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/{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/{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/{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/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or 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/{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/{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/{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}/l-interfaces/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/{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/{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/{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/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

create or update an existing sriov-vf
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

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

see node definition for valid relationships
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

delete an existing relationship
GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/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/{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/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/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/{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/{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
DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

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/{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/{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/{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/{interface-name}/vlans/vlan/{vlan-interface}/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
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
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
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
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/zones

returns zones
GET /network/zones/zone/{zone-id}

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

create or 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

Paths

returns connectors

GET /business/connectors

Tags: Business

returns connectors

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
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string

application/json application/xml

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.

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
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string

application/json application/xml

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
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string

application/json application/xml

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.

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
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

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 ECOMP to uniquely identify customer.

 path string
subscriber-name

Subscriber name, an alternate way to retrieve a customer.

 query string
subscriber-type

Subscriber type, a way to provide VID with only the INFRA customers.

 query string

application/json application/xml

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 ECOMP 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 ECOMP 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
global-customer-id

Global customer id used across ECOMP 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 ECOMP 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 ECOMP to uniquely identify customer.

 path string
subscriber-name

Subscriber name, an alternate way to retrieve a customer.

 query string
subscriber-type

Subscriber type, a way to provide VID with only the INFRA customers.

 query string

application/json application/xml

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 ECOMP to uniquely identify customer.

 path string
service-type

Value defined by orchestration to identify this service across ECOMP.

 path string
subscriber-name

Subscriber name, an alternate way to retrieve a customer.

 query string
subscriber-type

Subscriber type, a way to provide VID with only the INFRA customers.

 query string

application/json application/xml

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 ECOMP to uniquely identify customer.

 path string
service-type

Value defined by orchestration to identify this service across ECOMP.

 path string

application/json application/xml

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 ECOMP to uniquely identify customer.

 path string
service-type

Value defined by orchestration to identify this service across ECOMP.

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

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
global-customer-id

Global customer id used across ECOMP to uniquely identify customer.

 path string
service-type

Value defined by orchestration to identify this service across ECOMP.

 path string

application/json application/xml

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 ECOMP to uniquely identify customer.

 path string
service-type

Value defined by orchestration to identify this service across ECOMP.

 path string

application/json application/xml

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 ECOMP to uniquely identify customer.

 path string
service-type

Value defined by orchestration to identify this service across ECOMP.

 path string
subscriber-name

Subscriber name, an alternate way to retrieve a customer.

 query string
subscriber-type

Subscriber type, a way to provide VID with only the INFRA customers.

 query string

application/json application/xml

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 ECOMP to uniquely identify customer.

 path string
service-type

Value defined by orchestration to identify this service across ECOMP.

 path string
service-instance-id

Uniquely identifies this instance of a service

 path string
subscriber-name

Subscriber name, an alternate way to retrieve a customer.

 query string
subscriber-type

Subscriber type, a way to provide VID with only the INFRA customers.

 query string
service-instance-name

This field will store a name assigned to the service-instance.

 query string
environment-context

This field will store the environment context assigned to the service-instance.

 query string
workload-context

This field will store the workload context assigned to the service-instance.

 query string
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
service-instance-location-id

An identifier that customers assign to the location where this service is being used.

 query string
orchestration-status

Orchestration status of this service.

 query 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 ECOMP to uniquely identify customer.

 path string
service-type

Value defined by orchestration to identify this service across ECOMP.

 path string
service-instance-id

Uniquely identifies this instance of a service

 path string

application/json application/xml

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 ECOMP to uniquely identify customer.

 path string
service-type

Value defined by orchestration to identify this service across ECOMP.

 path string
service-instance-id

Uniquely identifies this instance of a service

 path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

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 ECOMP to uniquely identify customer.

 path string
service-type

Value defined by orchestration to identify this service across ECOMP.

 path string
service-instance-id

Uniquely identifies this instance of a service

 path string
subscriber-name

Subscriber name, an alternate way to retrieve a customer.

 query string
subscriber-type

Subscriber type, a way to provide VID with only the INFRA customers.

 query string
service-instance-name

This field will store a name assigned to the service-instance.

 query string
environment-context

This field will store the environment context assigned to the service-instance.

 query string
workload-context

This field will store the workload context assigned to the service-instance.

 query string
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
service-instance-location-id

An identifier that customers assign to the location where this service is being used.

 query string
orchestration-status

Orchestration status of this service.

 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 ECOMP to uniquely identify customer.

 path string
service-type

Value defined by orchestration to identify this service across ECOMP.

 path string
service-instance-id

Uniquely identifies this instance of a service

 path string
id

Allotted Resource id UUID assigned to this instance.

 path string
subscriber-name

Subscriber name, an alternate way to retrieve a customer.

 query string
subscriber-type

Subscriber type, a way to provide VID with only the INFRA customers.

 query string
service-instance-name

This field will store a name assigned to the service-instance.

 query string
environment-context

This field will store the environment context assigned to the service-instance.

 query string
workload-context

This field will store the workload context assigned to the service-instance.

 query string
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
service-instance-location-id

An identifier that customers assign to the location where this service is being used.

 query string
orchestration-status

Orchestration status of this service.

 query string
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
type

Generic description of the type of allotted resource.

 query string
role

role in the network that this resource will be providing.

 query 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 ECOMP to uniquely identify customer.

 path string
service-type

Value defined by orchestration to identify this service across ECOMP.

 path string
service-instance-id

Uniquely identifies this instance of a service

 path string
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 ECOMP to uniquely identify customer.

 path string
service-type

Value defined by orchestration to identify this service across ECOMP.

 path string
service-instance-id

Uniquely identifies this instance of a service

 path string
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
global-customer-id

Global customer id used across ECOMP to uniquely identify customer.

 path string
service-type

Value defined by orchestration to identify this service across ECOMP.

 path string
service-instance-id

Uniquely identifies this instance of a service

 path string
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 ECOMP to uniquely identify customer.

 path string
service-type

Value defined by orchestration to identify this service across ECOMP.

 path string
service-instance-id

Uniquely identifies this instance of a service

 path string
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 ECOMP to uniquely identify customer.

 path string
service-type

Value defined by orchestration to identify this service across ECOMP.

 path string
service-instance-id

Uniquely identifies this instance of a service

 path string
id

Allotted Resource id UUID assigned to this instance.

 path string
subscriber-name

Subscriber name, an alternate way to retrieve a customer.

 query string
subscriber-type

Subscriber type, a way to provide VID with only the INFRA customers.

 query string
service-instance-name

This field will store a name assigned to the service-instance.

 query string
environment-context

This field will store the environment context assigned to the service-instance.

 query string
workload-context

This field will store the workload context assigned to the service-instance.

 query string
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
service-instance-location-id

An identifier that customers assign to the location where this service is being used.

 query string
orchestration-status

Orchestration status of this service.

 query string
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
type

Generic description of the type of allotted resource.

 query string
role

role in the network that this resource will be providing.

 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/{id}

Tags: Business

returns tunnel-xconnect
global-customer-id

Global customer id used across ECOMP to uniquely identify customer.

 path string
service-type

Value defined by orchestration to identify this service across ECOMP.

 path string
service-instance-id

Uniquely identifies this instance of a service

 path string
id

Allotted Resource id UUID assigned to this instance.

 path string
id

Allotted Resource id UUID assigned to this instance.

 path string
subscriber-name

Subscriber name, an alternate way to retrieve a customer.

 query string
subscriber-type

Subscriber type, a way to provide VID with only the INFRA customers.

 query string
service-instance-name

This field will store a name assigned to the service-instance.

 query string
environment-context

This field will store the environment context assigned to the service-instance.

 query string
workload-context

This field will store the workload context assigned to the service-instance.

 query string
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
service-instance-location-id

An identifier that customers assign to the location where this service is being used.

 query string
orchestration-status

Orchestration status of this service.

 query string
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
type

Generic description of the type of allotted resource.

 query string
role

role in the network that this resource will be providing.

 query 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/{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 ECOMP to uniquely identify customer.

 path string
service-type

Value defined by orchestration to identify this service across ECOMP.

 path string
service-instance-id

Uniquely identifies this instance of a service

 path string
id

Allotted Resource id UUID assigned to this instance.

 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 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/{id}

Tags: Business

delete an existing tunnel-xconnect

application/json application/xml

global-customer-id

Global customer id used across ECOMP to uniquely identify customer.

 path string
service-type

Value defined by orchestration to identify this service across ECOMP.

 path string
service-instance-id

Uniquely identifies this instance of a service

 path string
id

Allotted Resource id UUID assigned to this instance.

 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}/tunnel-xconnects/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
global-customer-id

Global customer id used across ECOMP to uniquely identify customer.

 path string
service-type

Value defined by orchestration to identify this service across ECOMP.

 path string
service-instance-id

Uniquely identifies this instance of a service

 path string
id

Allotted Resource id UUID assigned to this instance.

 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}/tunnel-xconnects/tunnel-xconnect/{id}/relationship-list/relationship

Tags: Business

delete an existing relationship

application/json application/xml

global-customer-id

Global customer id used across ECOMP to uniquely identify customer.

 path string
service-type

Value defined by orchestration to identify this service across ECOMP.

 path string
service-instance-id

Uniquely identifies this instance of a service

 path string
id

Allotted Resource id UUID assigned to this instance.

 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 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 ECOMP to uniquely identify customer.

 path string
service-type

Value defined by orchestration to identify this service across ECOMP.

 path string
service-instance-id

Uniquely identifies this instance of a service

 path string
subscriber-name

Subscriber name, an alternate way to retrieve a customer.

 query string
subscriber-type

Subscriber type, a way to provide VID with only the INFRA customers.

 query string
service-instance-name

This field will store a name assigned to the service-instance.

 query string
environment-context

This field will store the environment context assigned to the service-instance.

 query string
workload-context

This field will store the workload context assigned to the service-instance.

 query string
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
service-instance-location-id

An identifier that customers assign to the location where this service is being used.

 query string
orchestration-status

Orchestration status of this service.

 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 ECOMP to uniquely identify customer.

 path string
service-type

Value defined by orchestration to identify this service across ECOMP.

 path string
service-instance-id

Uniquely identifies this instance of a service

 path string
metaname path string
subscriber-name

Subscriber name, an alternate way to retrieve a customer.

 query string
subscriber-type

Subscriber type, a way to provide VID with only the INFRA customers.

 query string
service-instance-name

This field will store a name assigned to the service-instance.

 query string
environment-context

This field will store the environment context assigned to the service-instance.

 query string
workload-context

This field will store the workload context assigned to the service-instance.

 query string
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
service-instance-location-id

An identifier that customers assign to the location where this service is being used.

 query string
orchestration-status

Orchestration status of this service.

 query 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 ECOMP to uniquely identify customer.

 path string
service-type

Value defined by orchestration to identify this service across ECOMP.

 path string
service-instance-id

Uniquely identifies this instance of a service

 path string
metaname path string

application/json application/xml

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 ECOMP to uniquely identify customer.

 path string
service-type

Value defined by orchestration to identify this service across ECOMP.

 path string
service-instance-id

Uniquely identifies this instance of a service

 path string
metaname path string
resource-version

resource-version for concurrency

 query string

application/json application/xml

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
global-customer-id

Global customer id used across ECOMP to uniquely identify customer.

 path string
service-type

Value defined by orchestration to identify this service across ECOMP.

 path string
service-instance-id

Uniquely identifies this instance of a service

 path string

application/json application/xml

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 ECOMP to uniquely identify customer.

 path string
service-type

Value defined by orchestration to identify this service across ECOMP.

 path string
service-instance-id

Uniquely identifies this instance of a service

 path string

application/json application/xml

default

Response codes found in response codes.

returns lines-of-business

GET /business/lines-of-business

Tags: Business

returns lines-of-business

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.

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
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

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.

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
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

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.

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
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

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.

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
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 cloud-regions

GET /cloud-infrastructure/cloud-regions

Tags: CloudInfrastructure

returns cloud-regions

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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string

application/json application/xml

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.

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 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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string

application/json application/xml

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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string

application/json application/xml

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.

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
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string

application/json application/xml

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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string
vcenter-url

URL used to reach the vcenter

 query string

application/json application/xml

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.

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
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string

application/json application/xml

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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string
system-name

name of external system.

 query string
system-type

it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.

 query 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.

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
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string

application/json application/xml

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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string
flavor-name

Flavor name

 query string

application/json application/xml

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.

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.

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
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string

application/json application/xml

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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string
group-type

Group type - the type of group this instance refers to

 query string
group-name

Group name - name assigned to the group

 query string

application/json application/xml

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.

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
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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 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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string

application/json application/xml

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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string
image-name

Image name

 query string
application

The application that the image instantiates.

 query string
application-vendor

The vendor of the application.

 query string
application-version

The version of the application.

 query string

application/json application/xml

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.

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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string
image-name

Image name

 query string
application

The application that the image instantiates.

 query string
application-vendor

The vendor of the application.

 query string
application-version

The version of the application.

 query string

application/json application/xml

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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string
image-name

Image name

 query string
application

The application that the image instantiates.

 query string
application-vendor

The vendor of the application.

 query string
application-version

The version of the application.

 query string

application/json application/xml

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.

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
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string

application/json application/xml

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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string
network-name

Name of the network.

 query string
cvlan-tag

cvlan-id

 query integer

application/json application/xml

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.

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
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string

application/json application/xml

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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string
snapshot-name

Snapshot name

 query string
application

The application that the image instantiates.

 query string
application-vendor

The vendor of the application.

 query string
application-version

The version of the application.

 query string
prev-snapshot-id

This field contains the UUID of the previous snapshot (if any).

 query string

application/json application/xml

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.

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
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string

application/json application/xml

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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string
tenant-name

Readable name of tenant

 query string
tenant-context

This field will store the tenant context.

 query 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.

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.

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
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

 path string
cloud-region-id

Identifier used 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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string
tenant-name

Readable name of tenant

 query string
tenant-context

This field will store the tenant context.

 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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string
tenant-name

Readable name of tenant

 query string
tenant-context

This field will store the tenant context.

 query string
vserver-name

Name of vserver

 query string
vserver-name2

Alternative name of vserver

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
in-maint query boolean
is-closed-loop-disabled query boolean

application/json application/xml

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.

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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string
tenant-name

Readable name of tenant

 query string
tenant-context

This field will store the tenant context.

 query string
vserver-name

Name of vserver

 query string
vserver-name2

Alternative name of vserver

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
in-maint query boolean
is-closed-loop-disabled query boolean

application/json application/xml

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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string
tenant-name

Readable name of tenant

 query string
tenant-context

This field will store the tenant context.

 query string
vserver-name

Name of vserver

 query string
vserver-name2

Alternative name of vserver

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string

application/json application/xml

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.

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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string
tenant-name

Readable name of tenant

 query string
tenant-context

This field will store the tenant context.

 query string
vserver-name

Name of vserver

 query string
vserver-name2

Alternative name of vserver

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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.

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
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

 path string
cloud-region-id

Identifier used 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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string
tenant-name

Readable name of tenant

 query string
tenant-context

This field will store the tenant context.

 query string
vserver-name

Name of vserver

 query string
vserver-name2

Alternative name of vserver

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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.

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
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

 path string
cloud-region-id

Identifier used 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.

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
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

 path string
cloud-region-id

Identifier used 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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string
tenant-name

Readable name of tenant

 query string
tenant-context

This field will store the tenant context.

 query string
vserver-name

Name of vserver

 query string
vserver-name2

Alternative name of vserver

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string

application/json application/xml

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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string
tenant-name

Readable name of tenant

 query string
tenant-context

This field will store the tenant context.

 query string
vserver-name

Name of vserver

 query string
vserver-name2

Alternative name of vserver

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vf-vlan-filter

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

 query string
vf-mac-filter

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

 query string
vf-vlan-strip

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

 query boolean
neutron-network-id

Neutron network id of the interface

 query string

application/json application/xml

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.

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
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

 path string
cloud-region-id

Identifier used 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 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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string
tenant-name

Readable name of tenant

 query string
tenant-context

This field will store the tenant context.

 query string
vserver-name

Name of vserver

 query string
vserver-name2

Alternative name of vserver

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string

application/json application/xml

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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string
tenant-name

Readable name of tenant

 query string
tenant-context

This field will store the tenant context.

 query string
vserver-name

Name of vserver

 query string
vserver-name2

Alternative name of vserver

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
vpn-key

This indicates the customers VPN ID associated with this vlan

 query 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.

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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string
tenant-name

Readable name of tenant

 query string
tenant-context

This field will store the tenant context.

 query string
vserver-name

Name of vserver

 query string
vserver-name2

Alternative name of vserver

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
vpn-key

This indicates the customers VPN ID associated with this vlan

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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.

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
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

 path string
cloud-region-id

Identifier used 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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string
tenant-name

Readable name of tenant

 query string
tenant-context

This field will store the tenant context.

 query string
vserver-name

Name of vserver

 query string
vserver-name2

Alternative name of vserver

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
vpn-key

This indicates the customers VPN ID associated with this vlan

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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.

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
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

 path string
cloud-region-id

Identifier used 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
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

 path string
cloud-region-id

Identifier used 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
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

 path string
cloud-region-id

Identifier used 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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string
tenant-name

Readable name of tenant

 query string
tenant-context

This field will store the tenant context.

 query string
vserver-name

Name of vserver

 query string
vserver-name2

Alternative name of vserver

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
in-maint query boolean
is-closed-loop-disabled query boolean

application/json application/xml

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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string
tenant-name

Readable name of tenant

 query string
tenant-context

This field will store the tenant context.

 query string
vserver-name

Name of vserver

 query string
vserver-name2

Alternative name of vserver

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
in-maint query boolean
is-closed-loop-disabled query boolean

application/json application/xml

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.

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
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

 path string
cloud-region-id

Identifier used 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 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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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.

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
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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.

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
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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 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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string

application/json application/xml

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
cloud-type

Type of the cloud (e.g., openstack)

 query string
owner-defined-type

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query string
volume-group-name

Name of the volume group.

 query string
heat-stack-id

Heat stack id corresponding to this volume-group

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query 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.

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
cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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

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
data-center-code

Data center code which can be an alternate way to identify a complex

 query string
complex-name

Gamma complex name for LCP instance.

 query string
identity-url

URL of the keystone identity service

 query string

application/json application/xml

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.

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 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
data-center-code

Data center code which can be an alternate way to identify a complex

 query string
complex-name

Gamma complex name for LCP instance.

 query string
identity-url

URL of the keystone identity service

 query string

application/json application/xml

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
data-center-code

Data center code which can be an alternate way to identify a complex

 query string
complex-name

Gamma complex name for LCP instance.

 query string
identity-url

URL of the keystone identity service

 query string

application/json application/xml

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.

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
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.

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
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 network-profiles

GET /cloud-infrastructure/network-profiles

Tags: CloudInfrastructure

returns network-profiles

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.

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
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 pservers

GET /cloud-infrastructure/pservers

Tags: CloudInfrastructure

returns pservers

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
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
pserver-id

ID of Pserver

 query string
in-maint query boolean
pserver-name2

alternative pserver name

 query 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.

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 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
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
pserver-id

ID of Pserver

 query string
in-maint query boolean
pserver-name2

alternative pserver name

 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
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
pserver-id

ID of Pserver

 query string
in-maint query boolean
pserver-name2

alternative pserver name

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query 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.

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 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
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
pserver-id

ID of Pserver

 query string
in-maint query boolean
pserver-name2

alternative pserver name

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 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/{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
interface-name

Name given to the interface

 path string
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
pserver-id

ID of Pserver

 query string
in-maint query boolean
pserver-name2

alternative pserver name

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string

application/json application/xml

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/{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
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/{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
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/{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
interface-name

Name given to the interface

 path string
l3-interface-ipv4-address

IP address

 path string
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
pserver-id

ID of Pserver

 query string
in-maint query boolean
pserver-name2

alternative pserver name

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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/{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
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/{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
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/{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
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
interface-name

Name given to the interface

 path string
l3-interface-ipv4-address

IP address

 path string

application/json application/xml

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/{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
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/{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
interface-name

Name given to the interface

 path string
l3-interface-ipv6-address

IP address

 path string
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
pserver-id

ID of Pserver

 query string
in-maint query boolean
pserver-name2

alternative pserver name

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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/{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
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/{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
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/{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
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
interface-name

Name given to the interface

 path string
l3-interface-ipv6-address

IP address

 path string

application/json application/xml

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/{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
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.

see node definition for valid relationships

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/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
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
interface-name

Name given to the interface

 path string

application/json application/xml

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/{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
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/{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
interface-name

Name given to the interface

 path string
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
pserver-id

ID of Pserver

 query string
in-maint query boolean
pserver-name2

alternative pserver name

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string

application/json application/xml

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/{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
interface-name

Name given to the interface

 path string
pci-id

PCI ID used to identify the sriov-vf

 path string
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
pserver-id

ID of Pserver

 query string
in-maint query boolean
pserver-name2

alternative pserver name

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vf-vlan-filter

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

 query string
vf-mac-filter

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

 query string
vf-vlan-strip

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

 query boolean
neutron-network-id

Neutron network id of the interface

 query string

application/json application/xml

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/{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
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/{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
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/{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
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
interface-name

Name given to the interface

 path string
pci-id

PCI ID used to identify the sriov-vf

 path string

application/json application/xml

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/{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
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 vlans

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/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 that identifies the link aggregate interface

 path string
interface-name

Name given to the interface

 path string
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
pserver-id

ID of Pserver

 query string
in-maint query boolean
pserver-name2

alternative pserver name

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string

application/json application/xml

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/{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
interface-name

Name given to the interface

 path string
vlan-interface

String that identifies the interface

 path string
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
pserver-id

ID of Pserver

 query string
in-maint query boolean
pserver-name2

alternative pserver name

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
vpn-key

This indicates the customers VPN ID associated with this vlan

 query 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/{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
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/{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
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/{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
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
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
pserver-id

ID of Pserver

 query string
in-maint query boolean
pserver-name2

alternative pserver name

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
vpn-key

This indicates the customers VPN ID associated with this vlan

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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/{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
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/{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
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/{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
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
interface-name

Name given to the interface

 path string
vlan-interface

String that identifies the interface

 path string
l3-interface-ipv4-address

IP address

 path string

application/json application/xml

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/{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
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/{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
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
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
pserver-id

ID of Pserver

 query string
in-maint query boolean
pserver-name2

alternative pserver name

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
vpn-key

This indicates the customers VPN ID associated with this vlan

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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/{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
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/{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
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/{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
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
interface-name

Name given to the interface

 path string
vlan-interface

String that identifies the interface

 path string
l3-interface-ipv6-address

IP address

 path string

application/json application/xml

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/{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
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/{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
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
interface-name

Name given to the interface

 path string
vlan-interface

String that identifies the interface

 path string

application/json application/xml

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/{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
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/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
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 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
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
pserver-id

ID of Pserver

 query string
in-maint query boolean
pserver-name2

alternative pserver name

 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
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
pserver-id

ID of Pserver

 query string
in-maint query boolean
pserver-name2

alternative pserver name

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query 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.

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 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
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
pserver-id

ID of Pserver

 query string
in-maint query boolean
pserver-name2

alternative pserver name

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 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/{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
interface-name

Name given to the interface

 path string
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
pserver-id

ID of Pserver

 query string
in-maint query boolean
pserver-name2

alternative pserver name

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string

application/json application/xml

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/{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
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/{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
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/{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
interface-name

Name given to the interface

 path string
l3-interface-ipv4-address

IP address

 path string
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
pserver-id

ID of Pserver

 query string
in-maint query boolean
pserver-name2

alternative pserver name

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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/{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
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/{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
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/{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
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the physical interface

 path string
interface-name

Name given to the interface

 path string
l3-interface-ipv4-address

IP address

 path string

application/json application/xml

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/{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
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/{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
interface-name

Name given to the interface

 path string
l3-interface-ipv6-address

IP address

 path string
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
pserver-id

ID of Pserver

 query string
in-maint query boolean
pserver-name2

alternative pserver name

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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/{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
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/{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
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/{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
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the physical interface

 path string
interface-name

Name given to the interface

 path string
l3-interface-ipv6-address

IP address

 path string

application/json application/xml

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/{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
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.

see node definition for valid relationships

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/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
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the physical interface

 path string
interface-name

Name given to the interface

 path string

application/json application/xml

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/{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
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/{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
interface-name

Name given to the interface

 path string
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
pserver-id

ID of Pserver

 query string
in-maint query boolean
pserver-name2

alternative pserver name

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string

application/json application/xml

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/{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
interface-name

Name given to the interface

 path string
pci-id

PCI ID used to identify the sriov-vf

 path string
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
pserver-id

ID of Pserver

 query string
in-maint query boolean
pserver-name2

alternative pserver name

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vf-vlan-filter

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

 query string
vf-mac-filter

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

 query string
vf-vlan-strip

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

 query boolean
neutron-network-id

Neutron network id of the interface

 query string

application/json application/xml

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/{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
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/{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
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/{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
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the physical interface

 path string
interface-name

Name given to the interface

 path string
pci-id

PCI ID used to identify the sriov-vf

 path string

application/json application/xml

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/{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
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 vlans

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/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 that identifies the physical interface

 path string
interface-name

Name given to the interface

 path string
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
pserver-id

ID of Pserver

 query string
in-maint query boolean
pserver-name2

alternative pserver name

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string

application/json application/xml

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/{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
interface-name

Name given to the interface

 path string
vlan-interface

String that identifies the interface

 path string
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
pserver-id

ID of Pserver

 query string
in-maint query boolean
pserver-name2

alternative pserver name

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
vpn-key

This indicates the customers VPN ID associated with this vlan

 query 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/{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
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/{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
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/{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
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
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
pserver-id

ID of Pserver

 query string
in-maint query boolean
pserver-name2

alternative pserver name

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
vpn-key

This indicates the customers VPN ID associated with this vlan

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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/{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
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/{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
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/{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
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the physical interface

 path string
interface-name

Name given to the interface

 path string
vlan-interface

String that identifies the interface

 path string
l3-interface-ipv4-address

IP address

 path string

application/json application/xml

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/{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
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/{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
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
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
pserver-id

ID of Pserver

 query string
in-maint query boolean
pserver-name2

alternative pserver name

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
vpn-key

This indicates the customers VPN ID associated with this vlan

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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/{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
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/{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
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/{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
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the physical interface

 path string
interface-name

Name given to the interface

 path string
vlan-interface

String that identifies the interface

 path string
l3-interface-ipv6-address

IP address

 path string

application/json application/xml

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/{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
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/{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
hostname

Value from executing hostname on the compute node.

 path string
interface-name

Name that identifies the physical interface

 path string
interface-name

Name given to the interface

 path string
vlan-interface

String that identifies the interface

 path string

application/json application/xml

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/{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
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/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
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
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
pserver-id

ID of Pserver

 query string
in-maint query boolean
pserver-name2

alternative pserver name

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 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
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
pserver-id

ID of Pserver

 query string
in-maint query boolean
pserver-name2

alternative pserver name

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query 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.

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
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.

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
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

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
vdc-name

Name of the virtual data center

 query 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.

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
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 esr-ems-list

GET /external-system/esr-ems-list

Tags: ExternalSystem

returns esr-ems-list

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.

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

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
system-name

name of external system.

 query string
system-type

it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.

 query 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.

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
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
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-thirdparty-sdnc-list

GET /external-system/esr-thirdparty-sdnc-list

Tags: ExternalSystem

returns esr-thirdparty-sdnc-list

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.

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

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
system-name

name of external system.

 query string
system-type

it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.

 query 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.

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
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
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

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.

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

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
system-name

name of external system.

 query string
system-type

it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.

 query 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.

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
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
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 generic-vnfs

GET /network/generic-vnfs

Tags: Network

returns generic-vnfs

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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
nf-type

Generic description of the type of NF

 query string
nf-function

English description of Network function that the specific VNF deployment is providing

 query string
nf-role

role in the network that this model will be providing

 query string
nf-naming-code

string assigned to this model used for naming purposes

 query 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.

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 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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
nf-type

Generic description of the type of NF

 query string
nf-function

English description of Network function that the specific VNF deployment is providing

 query string
nf-role

role in the network that this model will be providing

 query string
nf-naming-code

string assigned to this model used for naming purposes

 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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
nf-type

Generic description of the type of NF

 query string
nf-function

English description of Network function that the specific VNF deployment is providing

 query string
nf-role

role in the network that this model will be providing

 query string
nf-naming-code

string assigned to this model used for naming purposes

 query 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.

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
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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
nf-type

Generic description of the type of NF

 query string
nf-function

English description of Network function that the specific VNF deployment is providing

 query string
nf-role

role in the network that this model will be providing

 query string
nf-naming-code

string assigned to this model used for naming purposes

 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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
nf-type

Generic description of the type of NF

 query string
nf-function

English description of Network function that the specific VNF deployment is providing

 query string
nf-role

role in the network that this model will be providing

 query string
nf-naming-code

string assigned to this model used for naming purposes

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string

application/json application/xml

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.

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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
nf-type

Generic description of the type of NF

 query string
nf-function

English description of Network function that the specific VNF deployment is providing

 query string
nf-role

role in the network that this model will be providing

 query string
nf-naming-code

string assigned to this model used for naming purposes

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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.

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
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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
nf-type

Generic description of the type of NF

 query string
nf-function

English description of Network function that the specific VNF deployment is providing

 query string
nf-role

role in the network that this model will be providing

 query string
nf-naming-code

string assigned to this model used for naming purposes

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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.

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
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.

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
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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
nf-type

Generic description of the type of NF

 query string
nf-function

English description of Network function that the specific VNF deployment is providing

 query string
nf-role

role in the network that this model will be providing

 query string
nf-naming-code

string assigned to this model used for naming purposes

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string

application/json application/xml

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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
nf-type

Generic description of the type of NF

 query string
nf-function

English description of Network function that the specific VNF deployment is providing

 query string
nf-role

role in the network that this model will be providing

 query string
nf-naming-code

string assigned to this model used for naming purposes

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vf-vlan-filter

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

 query string
vf-mac-filter

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

 query string
vf-vlan-strip

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

 query boolean
neutron-network-id

Neutron network id of the interface

 query string

application/json application/xml

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.

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
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 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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
nf-type

Generic description of the type of NF

 query string
nf-function

English description of Network function that the specific VNF deployment is providing

 query string
nf-role

role in the network that this model will be providing

 query string
nf-naming-code

string assigned to this model used for naming purposes

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string

application/json application/xml

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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
nf-type

Generic description of the type of NF

 query string
nf-function

English description of Network function that the specific VNF deployment is providing

 query string
nf-role

role in the network that this model will be providing

 query string
nf-naming-code

string assigned to this model used for naming purposes

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
vpn-key

This indicates the customers VPN ID associated with this vlan

 query 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.

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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
nf-type

Generic description of the type of NF

 query string
nf-function

English description of Network function that the specific VNF deployment is providing

 query string
nf-role

role in the network that this model will be providing

 query string
nf-naming-code

string assigned to this model used for naming purposes

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
vpn-key

This indicates the customers VPN ID associated with this vlan

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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.

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
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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
nf-type

Generic description of the type of NF

 query string
nf-function

English description of Network function that the specific VNF deployment is providing

 query string
nf-role

role in the network that this model will be providing

 query string
nf-naming-code

string assigned to this model used for naming purposes

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
vpn-key

This indicates the customers VPN ID associated with this vlan

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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.

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
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
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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
nf-type

Generic description of the type of NF

 query string
nf-function

English description of Network function that the specific VNF deployment is providing

 query string
nf-role

role in the network that this model will be providing

 query string
nf-naming-code

string assigned to this model used for naming purposes

 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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
nf-type

Generic description of the type of NF

 query string
nf-function

English description of Network function that the specific VNF deployment is providing

 query string
nf-role

role in the network that this model will be providing

 query string
nf-naming-code

string assigned to this model used for naming purposes

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query 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.

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 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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
nf-type

Generic description of the type of NF

 query string
nf-function

English description of Network function that the specific VNF deployment is providing

 query string
nf-role

role in the network that this model will be providing

 query string
nf-naming-code

string assigned to this model used for naming purposes

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 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/{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
interface-name

Name given to the interface

 path string
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
nf-type

Generic description of the type of NF

 query string
nf-function

English description of Network function that the specific VNF deployment is providing

 query string
nf-role

role in the network that this model will be providing

 query string
nf-naming-code

string assigned to this model used for naming purposes

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string

application/json application/xml

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/{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
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/{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
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/{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
interface-name

Name given to the interface

 path string
l3-interface-ipv4-address

IP address

 path string
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
nf-type

Generic description of the type of NF

 query string
nf-function

English description of Network function that the specific VNF deployment is providing

 query string
nf-role

role in the network that this model will be providing

 query string
nf-naming-code

string assigned to this model used for naming purposes

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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/{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
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/{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
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/{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
vnf-id

Unique id of VNF. This is unique across the graph.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
interface-name

Name given to the interface

 path string
l3-interface-ipv4-address

IP address

 path string

application/json application/xml

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/{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
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/{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
interface-name

Name given to the interface

 path string
l3-interface-ipv6-address

IP address

 path string
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
nf-type

Generic description of the type of NF

 query string
nf-function

English description of Network function that the specific VNF deployment is providing

 query string
nf-role

role in the network that this model will be providing

 query string
nf-naming-code

string assigned to this model used for naming purposes

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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/{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
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/{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
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/{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
vnf-id

Unique id of VNF. This is unique across the graph.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
interface-name

Name given to the interface

 path string
l3-interface-ipv6-address

IP address

 path string

application/json application/xml

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/{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
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.

see node definition for valid relationships

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-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
vnf-id

Unique id of VNF. This is unique across the graph.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
interface-name

Name given to the interface

 path string

application/json application/xml

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/{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
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/{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
interface-name

Name given to the interface

 path string
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
nf-type

Generic description of the type of NF

 query string
nf-function

English description of Network function that the specific VNF deployment is providing

 query string
nf-role

role in the network that this model will be providing

 query string
nf-naming-code

string assigned to this model used for naming purposes

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string

application/json application/xml

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/{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
interface-name

Name given to the interface

 path string
pci-id

PCI ID used to identify the sriov-vf

 path string
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
nf-type

Generic description of the type of NF

 query string
nf-function

English description of Network function that the specific VNF deployment is providing

 query string
nf-role

role in the network that this model will be providing

 query string
nf-naming-code

string assigned to this model used for naming purposes

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vf-vlan-filter

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

 query string
vf-mac-filter

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

 query string
vf-vlan-strip

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

 query boolean
neutron-network-id

Neutron network id of the interface

 query string

application/json application/xml

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/{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
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/{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
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/{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
vnf-id

Unique id of VNF. This is unique across the graph.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
interface-name

Name given to the interface

 path string
pci-id

PCI ID used to identify the sriov-vf

 path string

application/json application/xml

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/{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
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 vlans

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/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 that identifies the link aggregate interface

 path string
interface-name

Name given to the interface

 path string
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
nf-type

Generic description of the type of NF

 query string
nf-function

English description of Network function that the specific VNF deployment is providing

 query string
nf-role

role in the network that this model will be providing

 query string
nf-naming-code

string assigned to this model used for naming purposes

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string

application/json application/xml

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/{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
interface-name

Name given to the interface

 path string
vlan-interface

String that identifies the interface

 path string
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
nf-type

Generic description of the type of NF

 query string
nf-function

English description of Network function that the specific VNF deployment is providing

 query string
nf-role

role in the network that this model will be providing

 query string
nf-naming-code

string assigned to this model used for naming purposes

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
vpn-key

This indicates the customers VPN ID associated with this vlan

 query 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/{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
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/{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
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/{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
interface-name

Name given to the interface

 path string
vlan-interface

String that identifies the interface

 path string
l3-interface-ipv4-address

IP address

 path string
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
nf-type

Generic description of the type of NF

 query string
nf-function

English description of Network function that the specific VNF deployment is providing

 query string
nf-role

role in the network that this model will be providing

 query string
nf-naming-code

string assigned to this model used for naming purposes

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
vpn-key

This indicates the customers VPN ID associated with this vlan

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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/{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
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/{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
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/{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
vnf-id

Unique id of VNF. This is unique across the graph.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
interface-name

Name given to the interface

 path string
vlan-interface

String that identifies the interface

 path string
l3-interface-ipv4-address

IP address

 path string

application/json application/xml

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/{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
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/{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
interface-name

Name given to the interface

 path string
vlan-interface

String that identifies the interface

 path string
l3-interface-ipv6-address

IP address

 path string
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
nf-type

Generic description of the type of NF

 query string
nf-function

English description of Network function that the specific VNF deployment is providing

 query string
nf-role

role in the network that this model will be providing

 query string
nf-naming-code

string assigned to this model used for naming purposes

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
vpn-key

This indicates the customers VPN ID associated with this vlan

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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/{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
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/{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
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/{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
vnf-id

Unique id of VNF. This is unique across the graph.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
interface-name

Name given to the interface

 path string
vlan-interface

String that identifies the interface

 path string
l3-interface-ipv6-address

IP address

 path string

application/json application/xml

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/{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
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/{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
vnf-id

Unique id of VNF. This is unique across the graph.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
interface-name

Name given to the interface

 path string
vlan-interface

String that identifies the interface

 path string

application/json application/xml

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/{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
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/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
vnf-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 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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
nf-type

Generic description of the type of NF

 query string
nf-function

English description of Network function that the specific VNF deployment is providing

 query string
nf-role

role in the network that this model will be providing

 query string
nf-naming-code

string assigned to this model used for naming purposes

 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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
nf-type

Generic description of the type of NF

 query string
nf-function

English description of Network function that the specific VNF deployment is providing

 query string
nf-role

role in the network that this model will be providing

 query string
nf-naming-code

string assigned to this model used for naming purposes

 query 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.

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
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
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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
nf-type

Generic description of the type of NF

 query string
nf-function

English description of Network function that the specific VNF deployment is providing

 query string
nf-role

role in the network that this model will be providing

 query string
nf-naming-code

string assigned to this model used for naming purposes

 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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
nf-type

Generic description of the type of NF

 query string
nf-function

English description of Network function that the specific VNF deployment is providing

 query string
nf-role

role in the network that this model will be providing

 query string
nf-naming-code

string assigned to this model used for naming purposes

 query string
vf-module-name

Name of vf-module

 query string
heat-stack-id

Heat stack id corresponding to this instance.

 query string
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
contrail-service-instance-fqdn

the Contrail unique ID for a service-instance

 query string

application/json application/xml

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.

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
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 instance-groups

GET /network/instance-groups

Tags: Network

returns instance-groups

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
description

Descriptive text to help identify the usage of this instance-group

 query string
type

Only valid value today is lower case ha for high availability

 query string
sub-type

Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]

 query 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.

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
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 ipsec-configurations

GET /network/ipsec-configurations

Tags: Network

returns ipsec-configurations

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.

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
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

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.

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
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

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
network-name

Name of the network, governed by some naming convention..

 query string
network-role

Role the network plans - who defines these values?

 query string
service-id

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
contrail-network-fqdn

Contrail FQDN for the network

 query string
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string

application/json application/xml

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.

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 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
network-name

Name of the network, governed by some naming convention..

 query string
network-role

Role the network plans - who defines these values?

 query string
service-id

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
contrail-network-fqdn

Contrail FQDN for the network

 query string
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string

application/json application/xml

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
network-name

Name of the network, governed by some naming convention..

 query string
network-role

Role the network plans - who defines these values?

 query string
service-id

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
contrail-network-fqdn

Contrail FQDN for the network

 query string
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string

application/json application/xml

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.

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
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
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
network-name

Name of the network, governed by some naming convention..

 query string
network-role

Role the network plans - who defines these values?

 query string
service-id

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
contrail-network-fqdn

Contrail FQDN for the network

 query string
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string

application/json application/xml

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
network-name

Name of the network, governed by some naming convention..

 query string
network-role

Role the network plans - who defines these values?

 query string
service-id

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
contrail-network-fqdn

Contrail FQDN for the network

 query string
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string

application/json application/xml

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.

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
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
network-name

Name of the network, governed by some naming convention..

 query string
network-role

Role the network plans - who defines these values?

 query string
service-id

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
contrail-network-fqdn

Contrail FQDN for the network

 query string
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string

application/json application/xml

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
network-name

Name of the network, governed by some naming convention..

 query string
network-role

Role the network plans - who defines these values?

 query string
service-id

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
contrail-network-fqdn

Contrail FQDN for the network

 query string
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
subnet-name

Name associated with the subnet.

 query string

application/json application/xml

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.

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 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
network-name

Name of the network, governed by some naming convention..

 query string
network-role

Role the network plans - who defines these values?

 query string
service-id

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
contrail-network-fqdn

Contrail FQDN for the network

 query string
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
subnet-name

Name associated with the subnet.

 query string

application/json application/xml

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
network-name

Name of the network, governed by some naming convention..

 query string
network-role

Role the network plans - who defines these values?

 query string
service-id

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
contrail-network-fqdn

Contrail FQDN for the network

 query string
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
subnet-name

Name associated with the subnet.

 query string

application/json application/xml

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.

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
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.

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
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 lag-links

GET /network/lag-links

Tags: Network

returns lag-links

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.

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
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 logical-links

GET /network/logical-links

Tags: Network

returns logical-links

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
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
widget-model-id

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query string
widget-model-version

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query string
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
link-id

UUID of the logical-link, SDNC generates this.

 query string
circuit-id

Circuit id

 query string
purpose

Reason for this entity, role it is playing

 query 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.

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
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 multicast-configurations

GET /network/multicast-configurations

Tags: Network

returns multicast-configurations

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.

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
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

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
network-policy-fqdn

Contrail FQDN for the policy

 query 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.

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
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 newvces

GET /network/newvces

Tags: Network

returns newvces

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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string

application/json application/xml

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.

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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string

application/json application/xml

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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string

application/json application/xml

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.

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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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.

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
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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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.

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
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.

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
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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string

application/json application/xml

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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vf-vlan-filter

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

 query string
vf-mac-filter

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

 query string
vf-vlan-strip

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

 query boolean
neutron-network-id

Neutron network id of the interface

 query string

application/json application/xml

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.

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
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 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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string

application/json application/xml

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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
vpn-key

This indicates the customers VPN ID associated with this vlan

 query 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.

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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
vpn-key

This indicates the customers VPN ID associated with this vlan

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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.

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
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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
vpn-key

This indicates the customers VPN ID associated with this vlan

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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.

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
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
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
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 physical-links

GET /network/physical-links

Tags: Network

returns physical-links

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
circuit-id

Circuit it

 query 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.

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
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

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
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 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.

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 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
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 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
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query 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.

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 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
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 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/{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
interface-name

Name given to the interface

 path string
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string

application/json application/xml

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/{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
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/{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
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/{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
interface-name

Name given to the interface

 path string
l3-interface-ipv4-address

IP address

 path string
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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/{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
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/{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
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/{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
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
interface-name

Name given to the interface

 path string
l3-interface-ipv4-address

IP address

 path string

application/json application/xml

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/{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
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/{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
interface-name

Name given to the interface

 path string
l3-interface-ipv6-address

IP address

 path string
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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/{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
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/{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
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/{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
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
interface-name

Name given to the interface

 path string
l3-interface-ipv6-address

IP address

 path string

application/json application/xml

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/{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
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.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-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
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
interface-name

Name given to the interface

 path string

application/json application/xml

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/{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
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/{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
interface-name

Name given to the interface

 path string
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string

application/json application/xml

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/{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
interface-name

Name given to the interface

 path string
pci-id

PCI ID used to identify the sriov-vf

 path string
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vf-vlan-filter

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

 query string
vf-mac-filter

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

 query string
vf-vlan-strip

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

 query boolean
neutron-network-id

Neutron network id of the interface

 query string

application/json application/xml

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/{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
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/{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
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/{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
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
interface-name

Name given to the interface

 path string
pci-id

PCI ID used to identify the sriov-vf

 path string

application/json application/xml

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/{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
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 vlans

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-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 that identifies the link aggregate interface

 path string
interface-name

Name given to the interface

 path string
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string

application/json application/xml

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/{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
interface-name

Name given to the interface

 path string
vlan-interface

String that identifies the interface

 path string
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
vpn-key

This indicates the customers VPN ID associated with this vlan

 query 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/{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
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/{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
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/{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
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
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
vpn-key

This indicates the customers VPN ID associated with this vlan

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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/{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
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/{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
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/{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
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
interface-name

Name given to the interface

 path string
vlan-interface

String that identifies the interface

 path string
l3-interface-ipv4-address

IP address

 path string

application/json application/xml

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/{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
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/{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
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
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
vpn-key

This indicates the customers VPN ID associated with this vlan

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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/{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
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/{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
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/{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
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
interface-name

Name given to the interface

 path string
vlan-interface

String that identifies the interface

 path string
l3-interface-ipv6-address

IP address

 path string

application/json application/xml

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/{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
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/{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
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the link aggregate interface

 path string
interface-name

Name given to the interface

 path string
vlan-interface

String that identifies the interface

 path string

application/json application/xml

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/{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
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/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
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 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
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 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
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query 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.

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 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
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 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/{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
interface-name

Name given to the interface

 path string
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string

application/json application/xml

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/{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
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/{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
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/{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
interface-name

Name given to the interface

 path string
l3-interface-ipv4-address

IP address

 path string
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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/{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
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/{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
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/{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
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the physical interface

 path string
interface-name

Name given to the interface

 path string
l3-interface-ipv4-address

IP address

 path string

application/json application/xml

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/{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
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/{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
interface-name

Name given to the interface

 path string
l3-interface-ipv6-address

IP address

 path string
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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/{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
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/{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
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/{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
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the physical interface

 path string
interface-name

Name given to the interface

 path string
l3-interface-ipv6-address

IP address

 path string

application/json application/xml

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/{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
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.

see node definition for valid relationships

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-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
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the physical interface

 path string
interface-name

Name given to the interface

 path string

application/json application/xml

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/{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
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/{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
interface-name

Name given to the interface

 path string
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string

application/json application/xml

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/{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
interface-name

Name given to the interface

 path string
pci-id

PCI ID used to identify the sriov-vf

 path string
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vf-vlan-filter

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

 query string
vf-mac-filter

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

 query string
vf-vlan-strip

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

 query boolean
neutron-network-id

Neutron network id of the interface

 query string

application/json application/xml

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/{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
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/{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
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/{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
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the physical interface

 path string
interface-name

Name given to the interface

 path string
pci-id

PCI ID used to identify the sriov-vf

 path string

application/json application/xml

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/{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
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 vlans

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-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 that identifies the physical interface

 path string
interface-name

Name given to the interface

 path string
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string

application/json application/xml

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/{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
interface-name

Name given to the interface

 path string
vlan-interface

String that identifies the interface

 path string
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
vpn-key

This indicates the customers VPN ID associated with this vlan

 query 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/{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
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/{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
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/{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
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
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
vpn-key

This indicates the customers VPN ID associated with this vlan

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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/{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
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/{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
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/{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
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the physical interface

 path string
interface-name

Name given to the interface

 path string
vlan-interface

String that identifies the interface

 path string
l3-interface-ipv4-address

IP address

 path string

application/json application/xml

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/{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
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/{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
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
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
vpn-key

This indicates the customers VPN ID associated with this vlan

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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/{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
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/{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
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/{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
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the physical interface

 path string
interface-name

Name given to the interface

 path string
vlan-interface

String that identifies the interface

 path string
l3-interface-ipv6-address

IP address

 path string

application/json application/xml

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/{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
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/{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
pnf-name

unique name of Physical Network Function.

 path string
interface-name

Name that identifies the physical interface

 path string
interface-name

Name given to the interface

 path string
vlan-interface

String that identifies the interface

 path string

application/json application/xml

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/{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
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/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
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
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 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
inv-status

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query 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.

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
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.

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
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 route-table-references

GET /network/route-table-references

Tags: Network

returns route-table-references

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
route-table-reference-fqdn

FQDN entry in the route table.

 query 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.

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
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 site-pair-sets

GET /network/site-pair-sets

Tags: Network

returns site-pair-sets

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.

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
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

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.

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
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

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.

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

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.

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
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
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 vces

GET /network/vces

Tags: Network

returns vces

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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
vpe-id

Unique ID of VPE connected to this VCE.

 query string

application/json application/xml

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.

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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
vpe-id

Unique ID of VPE connected to this VCE.

 query string

application/json application/xml

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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
vpe-id

Unique ID of VPE connected to this VCE.

 query string

application/json application/xml

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.

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
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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
vpe-id

Unique ID of VPE connected to this VCE.

 query string

application/json application/xml

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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
vpe-id

Unique ID of VPE connected to this VCE.

 query string

application/json application/xml

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.

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
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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
vpe-id

Unique ID of VPE connected to this VCE.

 query string

application/json application/xml

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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
vpe-id

Unique ID of VPE connected to this VCE.

 query string
port-group-id

Unique ID for port group in vmware

 query string
switch-name

DVS or standard switch name (should be non-null for port groups associated with DVS)

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string

application/json application/xml

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.

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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
vpe-id

Unique ID of VPE connected to this VCE.

 query string
port-group-id

Unique ID for port group in vmware

 query string
switch-name

DVS or standard switch name (should be non-null for port groups associated with DVS)

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string

application/json application/xml

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
vnf-name

Name of VNF.

 query string
vnf-name2

Alternate name of VNF.

 query string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

 query string
service-id

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

 query string
regional-resource-zone

Regional way of organizing pservers, source of truth should define values

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string
vpe-id

Unique ID of VPE connected to this VCE.

 query string
port-group-id

Unique ID for port group in vmware

 query string
switch-name

DVS or standard switch name (should be non-null for port groups associated with DVS)

 query string
heat-stack-id

Heat stack id corresponding to this instance, managed by MSO

 query string

application/json application/xml

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.

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
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
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
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

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
nfc-naming-code

Short code that is used in naming instances of the item being modeled

 query string
nfc-function

English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service

 query string
prov-status

prov status of this vnfc

 query string
ipaddress-v4-oam-vip

Oam V4 vip address of this vnfc

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
group-notation

Group notation of VNFC

 query string
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query 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.

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 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
nfc-naming-code

Short code that is used in naming instances of the item being modeled

 query string
nfc-function

English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service

 query string
prov-status

prov status of this vnfc

 query string
ipaddress-v4-oam-vip

Oam V4 vip address of this vnfc

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
group-notation

Group notation of VNFC

 query string
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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.

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
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
nfc-naming-code

Short code that is used in naming instances of the item being modeled

 query string
nfc-function

English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service

 query string
prov-status

prov status of this vnfc

 query string
ipaddress-v4-oam-vip

Oam V4 vip address of this vnfc

 query string
in-maint query boolean
is-closed-loop-disabled query boolean
group-notation

Group notation of VNFC

 query string
model-invariant-id

the ASDC model id for this resource or service model.

 query string
model-version-id

the ASDC model version for this resource or service model.

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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.

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
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
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

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
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query 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.

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
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 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
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query 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.

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 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
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 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/{interface-name}

Tags: Network

returns l-interface
equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
interface-name

Name given to the interface

 path string
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string

application/json application/xml

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/{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
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/{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
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/{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
interface-name

Name given to the interface

 path string
l3-interface-ipv4-address

IP address

 path string
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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/{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
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/{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
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/{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
equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
interface-name

Name given to the interface

 path string
l3-interface-ipv4-address

IP address

 path string

application/json application/xml

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/{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
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/{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
interface-name

Name given to the interface

 path string
l3-interface-ipv6-address

IP address

 path string
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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/{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
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/{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
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/{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
equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
interface-name

Name given to the interface

 path string
l3-interface-ipv6-address

IP address

 path string

application/json application/xml

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/{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
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.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-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
equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
interface-name

Name given to the interface

 path string

application/json application/xml

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/{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
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/{interface-name}/sriov-vfs

Tags: Network

returns sriov-vfs
equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
interface-name

Name given to the interface

 path string
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string

application/json application/xml

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/{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
interface-name

Name given to the interface

 path string
pci-id

PCI ID used to identify the sriov-vf

 path string
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vf-vlan-filter

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

 query string
vf-mac-filter

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

 query string
vf-vlan-strip

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

 query boolean
neutron-network-id

Neutron network id of the interface

 query string

application/json application/xml

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/{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
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/{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
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/{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
equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
interface-name

Name given to the interface

 path string
pci-id

PCI ID used to identify the sriov-vf

 path string

application/json application/xml

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/{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
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 vlans

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

Tags: Network

returns vlans
equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
interface-name

Name given to the interface

 path string
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string

application/json application/xml

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/{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
interface-name

Name given to the interface

 path string
vlan-interface

String that identifies the interface

 path string
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
vpn-key

This indicates the customers VPN ID associated with this vlan

 query 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/{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
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/{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
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/{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
interface-name

Name given to the interface

 path string
vlan-interface

String that identifies the interface

 path string
l3-interface-ipv4-address

IP address

 path string
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
vpn-key

This indicates the customers VPN ID associated with this vlan

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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/{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
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/{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
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/{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
equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
interface-name

Name given to the interface

 path string
vlan-interface

String that identifies the interface

 path string
l3-interface-ipv4-address

IP address

 path string

application/json application/xml

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/{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
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/{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
interface-name

Name given to the interface

 path string
vlan-interface

String that identifies the interface

 path string
l3-interface-ipv6-address

IP address

 path string
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
interface-id

ID of interface

 query string
interface-role

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
vpn-key

This indicates the customers VPN ID associated with this vlan

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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/{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
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/{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
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/{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
equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
interface-name

Name given to the interface

 path string
vlan-interface

String that identifies the interface

 path string
l3-interface-ipv6-address

IP address

 path string

application/json application/xml

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/{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
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/{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
equipment-name path string
interface-name

Name that identifies the link aggregate interface

 path string
interface-name

Name given to the interface

 path string
vlan-interface

String that identifies the interface

 path string

application/json application/xml

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/{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
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/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
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 p-interfaces

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces

Tags: Network

returns p-interfaces
equipment-name path string
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string

application/json application/xml

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
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query 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.

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 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
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 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/{interface-name}

Tags: Network

returns l-interface
equipment-name path string
interface-name

Name that identifies the physical interface

 path string
interface-name

Name given to the interface

 path string
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string

application/json application/xml

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/{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
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/{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
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/{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
interface-name

Name given to the interface

 path string
l3-interface-ipv4-address

IP address

 path string
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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/{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
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/{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
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/{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
equipment-name path string
interface-name

Name that identifies the physical interface

 path string
interface-name

Name given to the interface

 path string
l3-interface-ipv4-address

IP address

 path string

application/json application/xml

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/{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
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/{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
interface-name

Name given to the interface

 path string
l3-interface-ipv6-address

IP address

 path string
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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/{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
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/{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
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/{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
equipment-name path string
interface-name

Name that identifies the physical interface

 path string
interface-name

Name given to the interface

 path string
l3-interface-ipv6-address

IP address

 path string

application/json application/xml

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/{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
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.

see node definition for valid relationships

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-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
equipment-name path string
interface-name

Name that identifies the physical interface

 path string
interface-name

Name given to the interface

 path string

application/json application/xml

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/{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
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/{interface-name}/sriov-vfs

Tags: Network

returns sriov-vfs
equipment-name path string
interface-name

Name that identifies the physical interface

 path string
interface-name

Name given to the interface

 path string
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string

application/json application/xml

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/{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
interface-name

Name given to the interface

 path string
pci-id

PCI ID used to identify the sriov-vf

 path string
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vf-vlan-filter

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

 query string
vf-mac-filter

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

 query string
vf-vlan-strip

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

 query boolean
neutron-network-id

Neutron network id of the interface

 query string

application/json application/xml

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/{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
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/{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
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/{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
equipment-name path string
interface-name

Name that identifies the physical interface

 path string
interface-name

Name given to the interface

 path string
pci-id

PCI ID used to identify the sriov-vf

 path string

application/json application/xml

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/{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
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 vlans

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

Tags: Network

returns vlans
equipment-name path string
interface-name

Name that identifies the physical interface

 path string
interface-name

Name given to the interface

 path string
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string

application/json application/xml

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/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

returns vlan
equipment-name path string
interface-name

Name that identifies the physical interface

 path string
interface-name

Name given to the interface

 path string
vlan-interface

String that identifies the interface

 path string
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
vpn-key

This indicates the customers VPN ID associated with this vlan

 query 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/{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
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/{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
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/{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
interface-name

Name given to the interface

 path string
vlan-interface

String that identifies the interface

 path string
l3-interface-ipv4-address

IP address

 path string
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
vpn-key

This indicates the customers VPN ID associated with this vlan

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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/{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
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/{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
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/{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
equipment-name path string
interface-name

Name that identifies the physical interface

 path string
interface-name

Name given to the interface

 path string
vlan-interface

String that identifies the interface

 path string
l3-interface-ipv4-address

IP address

 path string

application/json application/xml

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/{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
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/{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
interface-name

Name given to the interface

 path string
vlan-interface

String that identifies the interface

 path string
l3-interface-ipv6-address

IP address

 path string
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query string
interface-id

ID of interface

 query string
macaddr

MAC address for the interface

 query string
network-name

Name of the network

 query string
vlan-id-inner

Inner VLAN tag

 query integer
vpn-key

This indicates the customers VPN ID associated with this vlan

 query string
vlan-id-inner

Inner VLAN tag

 query integer
neutron-network-id

Neutron network id of the interface that address belongs to

 query string
neutron-subnet-id

Neutron id of subnet that address belongs to

 query string

application/json application/xml

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/{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
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/{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
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/{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
equipment-name path string
interface-name

Name that identifies the physical interface

 path string
interface-name

Name given to the interface

 path string
vlan-interface

String that identifies the interface

 path string
l3-interface-ipv6-address

IP address

 path string

application/json application/xml

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/{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
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/{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
equipment-name path string
interface-name

Name that identifies the physical interface

 path string
interface-name

Name given to the interface

 path string
vlan-interface

String that identifies the interface

 path string

application/json application/xml

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/{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
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/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
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
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 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
prov-status

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query string
prov-status

Trigger for operational monitoring of this resource by Service Assurance systems.

 query 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.

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
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.

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
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

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
vpn-name

VPN Name

 query string
vpn-type

Type of the vpn, should be taken from enumerated/valid values

 query 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.

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
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
vpn-name

VPN Name

 query string
vpn-type

Type of the vpn, should be taken from enumerated/valid values

 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
vpn-name

VPN Name

 query string
vpn-type

Type of the vpn, should be taken from enumerated/valid values

 query 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.

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
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 zones

GET /network/zones

Tags: Network

returns zones

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
design-type

Design of zone [Medium/Large?]

 query string
zone-context

Context of zone [production/test]

 query 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.

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
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 models

GET /service-design-and-creation/models

Tags: ServiceDesignAndCreation

returns models

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
model-type

Type of the model, e.g., service, resource, widget, etc.

 query 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.

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-type

Type of the model, e.g., service, resource, widget, etc.

 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
model-type

Type of the model, e.g., service, resource, widget, etc.

 query string
model-name

Name of the model, which can change from version to version.

 query string
model-version

Version

 query 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.

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
model-type

Type of the model, e.g., service, resource, widget, etc.

 query string
model-name

Name of the model, which can change from version to version.

 query string
model-version

Version

 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
model-type

Type of the model, e.g., service, resource, widget, etc.

 query string
model-name

Name of the model, which can change from version to version.

 query string
model-version

Version

 query 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.

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-type

Type of the model, e.g., service, resource, widget, etc.

 query string
model-name

Name of the model, which can change from version to version.

 query string
model-version

Version

 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
model-type

Type of the model, e.g., service, resource, widget, etc.

 query string
model-name

Name of the model, which can change from version to version.

 query string
model-version

Version

 query 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.

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-type

Type of the model, e.g., service, resource, widget, etc.

 query string
model-name

Name of the model, which can change from version to version.

 query string
model-version

Version

 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
model-type

Type of the model, e.g., service, resource, widget, etc.

 query string
model-name

Name of the model, which can change from version to version.

 query string
model-version

Version

 query 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.

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
model-type

Type of the model, e.g., service, resource, widget, etc.

 query string
model-name

Name of the model, which can change from version to version.

 query string
model-version

Version

 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
model-type

Type of the model, e.g., service, resource, widget, etc.

 query string
model-name

Name of the model, which can change from version to version.

 query string
model-version

Version

 query 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.

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
model-type

Type of the model, e.g., service, resource, widget, etc.

 query string
model-name

Name of the model, which can change from version to version.

 query string
model-version

Version

 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
model-type

Type of the model, e.g., service, resource, widget, etc.

 query string
model-name

Name of the model, which can change from version to version.

 query string
model-version

Version

 query 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.

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
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
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
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
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
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

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
named-query-name query 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.

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-name 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
named-query-name query 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.

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
named-query-name 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
named-query-name query 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.

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
named-query-name 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
named-query-name query 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.

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
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
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
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

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 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.

 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 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.

 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 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.

 path string
resource-version

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
service-type

This gets defined by others to provide a unique ID for the service, we accept what is sent.

 path string
vnf-type

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP 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 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.

 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

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
service-description

Description of the service

 query 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.

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
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

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

The application that the image instantiates.

 query string
application-vendor

The vendor of the application.

 query string
application-version

The version of the application.

 query string

application/json application/xml

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.

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
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

allotted-resource: object

Represents a slice or partial piece of a resource that gets separately allotted

  • TO generic-vnf (Many2Many)
  • TO l3-network (Many2Many)
  • TO instance-group (Many2Many)
  • TO network-policy (One2One)
  • TO vlan (Many2Many)
  • TO l-interface (One2Many)
  • TO tunnel-xconnect (comprises allotted-resource, One2One)
  • TO vpn-binding (Many2Many)
  • TO allotted-resource (One2One)
  • FROM configuration
  • FROM service-instance (is composed of allotted-resource)
  • FROM service-instance
  • FROM allotted-resource
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.

persona-model-version: 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.

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

availability-zone: object

Availability zone, a collection of compute hosts/pservers

  • TO complex (Many2Many)
  • TO service-capability (Many2Many)
  • FROM cloud-region (is composed of availability-zone)
  • FROM ctag-pool
  • FROM dvs-switch
  • FROM generic-vnf
  • FROM pserver
  • FROM vce
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.

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

az-and-dvs-switches: object

dvs-switches: object
dvs-switches
availability-zone: object
availability-zone

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

class-of-service: object

  • FROM site-pair (is composed of class-of-service)
cos: string

unique identifier of probe

probe-id: string

identifier of probe

probe-type: string

type of probe

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
virtual-data-centers: object[]
virtual-data-center

cloud-region: object

cloud-region designates an installation of a cloud cluster or region or instantiation.

  • TO esr-system-info (comprises cloud-region, One2Many)
  • TO complex (Many2One)
  • TO l3-network (Many2Many)
  • TO tenant (comprises cloud-region, One2Many)
  • TO image (comprises cloud-region, One2Many)
  • TO flavor (comprises cloud-region, One2Many)
  • TO availability-zone (comprises cloud-region, One2Many)
  • TO oam-network (comprises cloud-region, One2Many)
  • TO dvs-switch (comprises cloud-region, One2Many)
  • TO volume-group (comprises cloud-region, One2Many)
  • TO group-assignment (comprises cloud-region, One2Many)
  • TO snapshot (comprises cloud-region, One2Many)
  • TO zone (Many2One)
  • TO vip-ipv4-address-list (comprises cloud-region, One2Many)
  • TO vip-ipv6-address-list (comprises cloud-region, One2Many)
  • FROM pserver
  • FROM logical-link
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: boolean
cloud-extra-info: string

ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.

cloud-epa-caps: string

MultiVIM will discover and expose EPA capabilities.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

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
esr-system-info-list: object[]
esr-system-info
vip-ipv4-address-list: object[]
vip-ipv4-address-list
vip-ipv6-address-list: object[]
vip-ipv6-address-list

cloud-regions: object

cloud-region: object[]
cloud-region

complex: object

Collection of physical locations that can house cloud-regions.

  • TO ctag-pool (comprises complex, Many2Many)
  • TO l3-network (Many2Many)
  • FROM availability-zone
  • FROM cloud-region
  • FROM oam-network
  • FROM pserver
  • FROM pnf
  • FROM vce
  • FROM vpls-pe
  • FROM volume-group
  • FROM zone
  • FROM generic-vnf
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.

street1: string
street2: string
city: string
state: string
postal-code: string
country: string
region: string
latitude: string
longitude: string
elevation: string
lata: string
ctag-pools: object[]
ctag-pool
relationship-list: object[]
relationship

complexes: object

Collection of physical locations that can house cloud-regions.

complex: object[]
complex

configuration: object

Port Mirror Configuration.

  • TO logical-link (One2Many)
  • TO metadatum (comprises configuration, One2Many)
  • TO allotted-resource (One2One)
  • FROM service-instance
  • FROM generic-vnf
management-option: string

Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.

configuration-id: string

UUID assigned to configuration.

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

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object
relationship-list
metadata: object
metadata

configurations: object

Collection of configurations

configuration: object[]
configuration

connector: object

Collection of resource instances used to connect a variety of disparate inventory widgets

  • TO virtual-data-center (Many2Many)
  • TO metadatum (comprises connector, Many2Many)
  • FROM service-instance
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.

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.

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 element-choice-set (comprises constrained-element-set, One2Many)
  • FROM model-element (is composed of constrained-element-set)
  • FROM model-constraint (is composed of constrained-element-set)
constrained-element-set-uuid: string
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

ctag-assignment: object

  • FROM l3-network (is composed of ctag-assignment)
  • FROM service-instance
vlan-id-inner: integer

id.

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 (Many2Many)
  • FROM complex (is composed of ctag-pool)
  • FROM vpls-pe
  • FROM generic-vnf
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

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.

  • TO service-subscription (comprises customer, Many2Many)
global-customer-id: string

Global customer id used across ECOMP 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.

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

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

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 (Many2Many)
  • FROM cloud-region (is composed of dvs-switch)
switch-name: string

DVS switch name

vcenter-url: string

URL used to reach the vcenter

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

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 model-element (comprises element-choice-set, One2Many)
  • FROM constrained-element-set (is composed of element-choice-set)
element-choice-set-uuid: string
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

entitlement: object

Metadata for entitlement group.

  • FROM generic-vnf (is composed of entitlement)
  • FROM vce (is composed of entitlement)
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.

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

esr-ems: object

Persist EMS address information used by EMS driver.

  • TO esr-system-info (comprises esr-ems, One2Many)
ems-id: string

Unique ID of EMS.

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-system-info: object

Persist common address information of external systems.

  • FROM esr-ems (is composed of esr-system-info)
  • FROM esr-vnfm (is composed of esr-system-info)
  • FROM esr-thirdparty-sdnc (is composed of esr-system-info)
  • FROM cloud-region (is composed of esr-system-info)
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.

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 esr-system-info (comprises esr-thirdparty-sdnc, One2One)
  • TO pnf (One2Many)
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.

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.

  • TO esr-system-info (comprises esr-vnfm, One2One)
vnfm-id: string

Unique ID of VNFM.

vim-id: string

indecate the VIM to deploy VNF.

certificate-url: string

certificate url of VNFM.

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

external-system: object

Namespace for external system.

esr-ems-list: object[]
esr-ems
esr-vnfm-list: object[]
esr-vnfm
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.

  • FROM cloud-region (is composed of flavor)
  • FROM 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

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]
relationship

flavors: object

Collection of openstack flavors.

flavor: object[]
flavor

generic-vnf: object

General purpose VNF

  • TO license-key-resource (Many2Many)
  • TO l-interface (comprises generic-vnf, Many2Many)
  • TO availability-zone (Many2Many)
  • TO lag-interface (comprises generic-vnf, Many2Many)
  • TO l3-network (Many2Many)
  • TO pserver (Many2Many)
  • TO vnf-image (Many2One)
  • TO vserver (One2Many)
  • TO service-instance (Many2Many)
  • TO site-pair-set (Many2Many)
  • TO network-profile (Many2Many)
  • TO pnf (Many2Many)
  • TO ipsec-configuration (Many2One)
  • TO configuration (One2Many)
  • TO vf-module (comprises generic-vnf, One2Many)
  • TO volume-group (One2Many)
  • TO vnfc (One2Many)
  • TO instance-group (Many2Many)
  • TO entitlement (comprises generic-vnf, One2Many)
  • TO license (comprises generic-vnf, One2Many)
  • TO complex (Many2Many)
  • TO ctag-pool (Many2Many)
  • FROM line-of-business
  • FROM platform
  • FROM virtual-data-center
  • FROM logical-link
  • FROM allotted-resource
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 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.

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 by ATT or 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

in-maint: boolean
is-closed-loop-disabled: boolean
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

relationship-list: object[]
relationship
l-interfaces: object[]
l-interface
lag-interfaces: object[]
lag-interface
vf-modules: object[]
vf-module
licenses: object[]
license
entitlements: object[]
entitlement

generic-vnfs: object

Collection of VNFs

generic-vnf: object[]
generic-vnf

group-assignment: object

Openstack group-assignment used to store exclusivity groups (EG).

  • TO tenant (Many2Many)
  • TO pserver (One2Many)
  • FROM cloud-region (is composed of group-assignment)
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

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

host-route: object

  • FROM subnet (is composed of host-route)
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

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

image: object

Openstack image.

  • TO metadatum (comprises image, Many2Many)
  • FROM cloud-region (is composed of image)
  • FROM 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

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 model (Many2Many)
  • FROM l-interface
  • FROM vnfc
  • FROM l3-interface-ipv4-address-list
  • FROM l3-interface-ipv6-address-list
  • FROM l3-network
  • FROM pnf
  • FROM allotted-resource
  • FROM generic-vnf
  • FROM service-instance
  • FROM vip-ipv4-address-list
  • FROM vip-ipv6-address-list
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.

id: string

Instance Group ID, UUID assigned to this instance.

description: string

Descriptive text to help identify the usage of this instance-group

type: string

Only valid value today is lower case ha for high availability

sub-type: string

Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]

resource-version: string

Concurrency value

relationship-list: object[]
relationship

instance-groups: object

Collection of openstack route table references

instance-group: object[]
instance-group

inventory: object

search: object
search
actions: object
actions
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
aai-internal: object
aai-internal
nodes: object[]

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

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

  • TO vig-server (comprises ipsec-configuration, One2Many)
  • FROM generic-vnf
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

ATT can offer a 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

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

key-data: object

key-name: string
key-value: string

l-interface: object

Logical interfaces, e.g., a vnic.

  • TO instance-group (Many2Many)
  • TO l3-interface-ipv4-address-list (comprises l-interface, Many2Many)
  • TO l3-interface-ipv6-address-list (comprises l-interface, Many2Many)
  • TO l-interface (comprises l-interface, One2Many)
  • TO logical-link (Many2Many)
  • TO vlan (comprises l-interface, Many2Many)
  • TO sriov-vf (comprises l-interface, One2One)
  • FROM generic-vnf (is composed of l-interface)
  • FROM lag-interface (is composed of l-interface)
  • FROM newvce (is composed of l-interface)
  • FROM p-interface (is composed of l-interface)
  • FROM vserver (is composed of l-interface)
  • FROM allotted-resource
  • FROM l-interface (is composed of l-interface)
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.

is-port-mirrored: boolean
resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

in-maint: boolean
prov-status: string

Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].

is-ip-unnumbered: boolean
allowed-address-pairs: string

Freeform field for storing an ip address, list of ip addresses or a subnet block.

vlans: object[]
vlan
sriov-vfs: object[]
sriov-vf
l-interfaces: object[]
l-interface
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 instance-group (Many2Many)
  • TO l3-network (Many2Many)
  • TO subnet (Many2Many)
  • TO vnfc (is composed of l3-interface-ipv4-address-list, Many2One)
  • FROM l-interface (is composed of l3-interface-ipv4-address-list)
  • FROM vlan (is composed of l3-interface-ipv4-address-list)
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

relationship-list: object[]
relationship

l3-interface-ipv6-address-list: object

IPv6 Address Range

  • TO instance-group (Many2Many)
  • TO l3-network (Many2Many)
  • TO subnet (Many2Many)
  • TO vnfc (is composed of l3-interface-ipv6-address-list, Many2One)
  • FROM l-interface (is composed of l3-interface-ipv6-address-list)
  • FROM vlan (is composed of l3-interface-ipv6-address-list)
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

relationship-list: object[]
relationship

l3-network: object

Generic network definition

  • TO vpn-binding (Many2Many)
  • TO instance-group (Many2Many)
  • TO subnet (comprises l3-network, Many2Many)
  • TO service-instance (Many2Many)
  • TO ctag-assignment (comprises l3-network, Many2Many)
  • TO network-policy (Many2Many)
  • TO segmentation-assignment (comprises l3-network, One2Many)
  • TO route-table-reference (Many2Many)
  • FROM cloud-region
  • FROM complex
  • FROM generic-vnf
  • FROM l3-interface-ipv4-address-list
  • FROM l3-interface-ipv6-address-list
  • FROM tenant
  • FROM vf-module
  • FROM allotted-resource
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?

neutron-network-id: string

Neutron network id of this Interface

is-bound-to-vpn: boolean
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
is-shared-network: boolean
is-external-network: boolean
selflink: string

Path to the controller object.

operational-status: string

Indicator for whether the resource is considered operational.

subnets: object[]
subnet
ctag-assignments: object[]
ctag-assignment
segmentation-assignments: object[]
segmentation-assignment
relationship-list: object[]
relationship

l3-networks: object

l3-network: object[]
l3-network

lag-interface: object

Link aggregate interface

  • TO logical-link (Many2Many)
  • TO lag-link (Many2Many)
  • TO p-interface (Many2Many)
  • TO l-interface (comprises lag-interface, Many2Many)
  • FROM generic-vnf (is composed of lag-interface)
  • FROM pserver (is composed of lag-interface)
  • FROM pnf (is composed of lag-interface)
  • FROM vpls-pe (is composed of lag-interface)
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 ECOMP Yang models.

prov-status: string

Trigger for operational monitoring of this resource by Service Assurance systems.

in-maint: boolean
relationship-list: object[]
relationship
l-interfaces: object[]
l-interface

lag-interfaces: object

Collection of link aggregate interfaces.

lag-interface: object[]
lag-interface

license: object

Metadata for license group.

  • FROM generic-vnf (is composed of license)
  • FROM vce (is composed of license)
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.

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 generic-vnf (Many2Many)
line-of-business-name: string

Name of the line-of-business (product)

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

metadata: object

Collection of metadatum (key/value pairs)

metadatum: object[]
metadatum

metadatum: object

Key/value pairs

  • FROM configuration (is composed of metadatum)
  • FROM image (is composed of metadatum)
  • FROM model-ver (is composed of metadatum)
  • FROM service-instance (is composed of metadatum)
  • FROM connector (is composed of metadatum)
metaname: string
metaval: string
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

  • TO model-ver (comprises model, One2Many)
  • FROM named-query
  • FROM named-query-element
  • FROM instance-group
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.

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 constrained-element-set (comprises model-constraint, One2Many)
  • FROM model-element (is composed of model-constraint)
model-constraint-uuid: string
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 model-ver (Many2One)
  • TO model-element (comprises model-element, One2Many)
  • TO model-constraint (comprises model-element, One2Many)
  • TO constrained-element-set (comprises model-element, One2Many)
  • FROM model-ver (is composed of model-element)
  • FROM element-choice-set (is composed of model-element)
  • FROM model-element (is composed of model-element)
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.

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-element (comprises model-ver, One2Many)
  • TO metadatum (comprises model-ver, One2Many)
  • FROM model (is composed of model-ver)
  • FROM 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

model-description: string

Description

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

  • FROM vlan
multicast-configuration-id: string

Unique id of multicast configuration.

multicast-protocol: string

protocol of multicast configuration

rp-type: string

rp type of multicast configuration

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 (One2Many)
  • TO named-query-element (comprises named-query, One2One)
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 named-query-element (comprises named-query-element, Many2Many)
  • TO model (Many2One)
  • TO property-constraint (comprises named-query-element, One2Many)
  • TO related-lookup (comprises named-query-element, One2Many)
  • FROM named-query (is composed of named-query-element)
  • FROM named-query-element (is composed of named-query-element)
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
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

network-policies: object

network-policy: object[]
network-policy

network-policy: object

  • FROM l3-network
  • FROM allotted-resource
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

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]
relationship

network-profile: object

Network profile populated by SDN-GP for SNMP

  • FROM generic-vnf
nm-profile-name: string

Unique name of network profile.

community-string: string

Encrypted SNMP community string

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

newvce: object

This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.

  • TO l-interface (comprises newvce, Many2Many)
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

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

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 complex (Many2Many)
  • TO service-capability (Many2Many)
  • FROM cloud-region (is composed of oam-network)
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

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

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 service-instance (One2Many)
owning-entity-id: string

UUID of an owning entity

owning-entity-name: string

Owning entity name

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 l-interface (comprises p-interface, Many2Many)
  • TO physical-link (Many2Many)
  • TO logical-link (Many2One)
  • TO sriov-pf (comprises p-interface, One2One)
  • FROM lag-interface
  • FROM pserver (is composed of p-interface)
  • FROM pnf (is composed of p-interface)
  • FROM vpls-pe (is composed of p-interface)
interface-name: string

Name that identifies the physical interface

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.

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.

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
inv-status: string

inventory status

relationship-list: object[]
relationship
sriov-pfs: object[]
sriov-pf
l-interfaces: object[]
l-interface

p-interfaces: object

Collection of physical interfaces.

p-interface: object[]
p-interface

platform: object

describes a platform

  • TO generic-vnf (Many2Many)
platform-name: string

Name of the platform

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

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 p-interface (comprises pnf, Many2Many)
  • TO lag-interface (comprises pnf, One2Many)
  • TO complex (Many2One)
  • TO instance-group (Many2Many)
  • TO zone (Many2One)
  • FROM esr-thirdparty-sdnc
  • FROM generic-vnf
  • FROM logical-link
  • FROM service-instance
pnf-name: string

unique name of Physical Network Function.

pnf-name2: string

name of Physical Network Function.

pnf-name2-source: string

source of name2

pnf-id: string

id of 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 by ATT or customer

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
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.

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.

relationship-list: object[]
relationship
p-interfaces: object[]
p-interface
lag-interfaces: object[]
lag-interface

pnfs: object

Collection of Physical Network Functions.

pnf: object[]
pnf

port-group: object

Used to capture the network interfaces of this VCE

  • TO cvlan-tag (comprises port-group, Many2Many)
  • FROM vce (is composed of port-group)
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

cvlan-tags: object[]
cvlan-tag-entry
relationship-list: object[]
relationship

port-groups: object

port-group: object[]
port-group

project: object

describes the project

  • TO service-instance (One2Many)
project-name: string

Name of the project deploying a service

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

  • FROM named-query-element (is composed of property-constraint)
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 complex (Many2One)
  • TO cloud-region (Many2One)
  • TO availability-zone (Many2One)
  • TO lag-interface (comprises pserver, Many2Many)
  • TO p-interface (comprises pserver, Many2Many)
  • TO zone (Many2One)
  • FROM generic-vnf
  • FROM group-assignment
  • FROM vserver
  • FROM logical-link
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
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.

relationship-list: object[]
relationship
p-interfaces: object[]
p-interface
lag-interfaces: object[]
lag-interface

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

relationship: object

related-to: string

A keyword provided by A&AI to indicate type of node.

related-link: string

URL to the object in A&AI.

relationship-data: object[]
relationship-data
related-to-property: object[]
related-to-property

relationship-data: object

relationship-key: string

A keyword provided by A&AI to indicate an attribute.

relationship-value: string

Value of the attribute.

relationship-list: object

relationship: object[]
relationship

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
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.

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

  • FROM vpn-binding (is composed of route-target)
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

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

  • TO site-pair (comprises routing-instance, Many2Many)
  • FROM site-pair-set (is composed of routing-instance)
routing-instance-id: string

Unique id of routing instance

rpm-owner: string

rpm owner

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

sdn-zone-response: object

oam-networks: object
oam-networks
az-and-dvs-switches: object[]
az-and-dvs-switches

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.

  • FROM l3-network (is composed of segmentation-assignment)
segmentation-id: string

Route Table Reference id, UUID assigned to this instance.

resource-version: string

Concurrency value

relationship-list: object[]
relationship

segmentation-assignments: object

Collection of openstack segmentation assignments

segmentation-assignment: object[]
segmentation-assignment

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

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
  • FROM 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 ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

resource-version: 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 configuration (One2Many)
  • TO zone (Many2One)
  • TO cvlan-tag (Many2Many)
  • TO pnf (One2Many)
  • TO connector (Many2Many)
  • TO metadatum (comprises service-instance, Many2Many)
  • TO logical-link (Many2Many)
  • TO vlan (One2Many)
  • TO service-instance (One2Many)
  • TO ctag-assignment (One2Many)
  • TO instance-group (Many2Many)
  • TO allotted-resource (comprises service-instance, Many2Many)
  • TO allotted-resource (Many2Many)
  • FROM generic-vnf
  • FROM l3-network
  • FROM owning-entity
  • FROM project
  • FROM service-subscription (is composed of service-instance)
  • FROM vce
  • FROM service-instance
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.

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.

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.

relationship-list: object[]
relationship
metadata: object[]
metadatum
allotted-resources: object[]
allotted-resource

service-instances: object

Collection of service instances

service-instance: object[]
service-instance

service-subscription: object

Object that group service instances.

  • TO service-instance (comprises service-subscription, Many2Many)
  • FROM customer (is composed of service-subscription)
  • FROM tenant
service-type: string

Value defined by orchestration to identify this service across ECOMP.

temp-ub-sub-account-id: string

This property will be deleted from A&AI in the near future. Only stop gap solution.

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 class-of-service (comprises site-pair, Many2Many)
  • FROM routing-instance (is composed of site-pair)
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.

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 routing-instance (comprises site-pair-set, Many2Many)
  • FROM generic-vnf
site-pair-set-id: string

Unique id of site pair set.

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

snapshot: object

Openstack snapshot

  • FROM cloud-region (is composed of snapshot)
  • FROM vserver
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).

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

sriov-pf: object

SR-IOV Physical Function

  • FROM p-interface (is composed of sriov-pf)
  • FROM sriov-vf
pf-pci-id: string

Identifier for the sriov-pf

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 sriov-pf (Many2One)
  • FROM l-interface (is composed of sriov-vf)
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.

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 host-route (comprises subnet, One2Many)
  • FROM l3-interface-ipv4-address-list
  • FROM l3-interface-ipv6-address-list
  • FROM l3-network (is composed of subnet)
  • FROM vip-ipv4-address-list
  • FROM vip-ipv6-address-list
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

dhcp-enabled: boolean
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

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

host-routes: object[]
host-route
relationship-list: object[]
relationship

subnets: object

subnet: object[]
subnet

tagged-inventory-item-list: object

inventory-item: object[]
inventory-item

tenant: object

Openstack tenant

  • TO l3-network (Many2Many)
  • TO service-subscription (Many2Many)
  • TO vserver (comprises tenant, One2Many)
  • FROM cloud-region (is composed of tenant)
  • FROM group-assignment
  • FROM volume-group
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.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

vservers: object[]
vserver
relationship-list: object[]
relationship

tenants: object

Collection of openstack tenants.

tenant: object[]
tenant

tunnel-xconnect: object

Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted

  • FROM allotted-resource (is composed of tunnel-xconnect)
id: string

Allotted Resource id UUID assigned to this instance.

bandwidth-up-wan1: string

The WAN uplink bandwidth for WAN1

bandwidth-down-wan1: string

The WAN downlink bandwidth for WAN1

bandwidth-up-wan2: string

The WAN uplink bandwidth for WAN2

bandwidth-down-wan2: string

The WAN downlink bandwidth for WAN2

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

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

vce: object

Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.

  • TO availability-zone (Many2Many)
  • TO complex (Many2Many)
  • TO port-group (comprises vce, Many2Many)
  • TO vserver (Many2Many)
  • TO service-instance (Many2Many)
  • TO entitlement (comprises vce, One2Many)
  • TO license (comprises vce, One2Many)
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 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 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

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 volume-group (One2One)
  • TO l3-network (Many2Many)
  • TO vnfc (One2Many)
  • FROM vserver
  • FROM generic-vnf (is composed of vf-module)
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
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.

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

  • FROM ipsec-configuration (is composed of vig-server)
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

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 instance-group (Many2Many)
  • TO subnet (Many2Many)
  • FROM vnfc
  • FROM cloud-region (is composed of vip-ipv4-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

relationship-list: object[]
relationship

vip-ipv6-address-list: object

IPv6 Address Range

  • TO instance-group (Many2Many)
  • TO subnet (Many2Many)
  • FROM vnfc
  • FROM cloud-region (is composed of vip-ipv6-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

relationship-list: object[]
relationship

virtual-data-center: object

Virtual organization of cloud infrastructure elements in a data center context

  • TO generic-vnf (Many2Many)
  • TO logical-link (Many2Many)
  • FROM connector
vdc-id: string

Unique ID of the vdc

vdc-name: string

Name of the virtual data center

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 l3-interface-ipv4-address-list (comprises vlan, Many2Many)
  • TO l3-interface-ipv6-address-list (comprises vlan, Many2Many)
  • TO multicast-configuration (Many2Many)
  • TO logical-link (Many2Many)
  • FROM l-interface (is composed of vlan)
  • FROM service-instance
  • FROM allotted-resource
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-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
prov-status: string

Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].

is-ip-unnumbered: boolean
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

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
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

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 instance-group (Many2Many)
  • TO vip-ipv4-address-list (Many2Many)
  • TO vip-ipv6-address-list (Many2Many)
  • FROM vserver
  • FROM vf-module
  • FROM generic-vnf
  • FROM l3-interface-ipv4-address-list (comprises vnfc)
  • FROM l3-interface-ipv6-address-list (comprises vnfc)
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
is-closed-loop-disabled: boolean
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.

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

vnfcs: object

virtual network components associated with a vserver from application controller.

vnfc: object[]
vnfc

volume: object

Ephemeral Block storage volume.

  • FROM vserver (is composed of volume)
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

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 complex (Many2Many)
  • TO tenant (Many2Many)
  • FROM cloud-region (is composed of volume-group)
  • FROM vf-module
  • FROM generic-vnf
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 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.

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

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 (Many2Many)
  • TO ctag-pool (Many2Many)
  • TO p-interface (comprises vpls-pe, Many2Many)
  • TO lag-interface (comprises vpls-pe, Many2Many)
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

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 route-target (comprises vpn-binding, One2Many)
  • FROM l3-network
  • FROM logical-link
  • FROM allotted-resource
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.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

route-targets: object[]
route-target
relationship-list: object[]
relationship

vpn-bindings: object

vpn-binding: object[]
vpn-binding

vserver: object

Virtual Servers, aka virtual machine or VM.

  • TO flavor (Many2One)
  • TO image (Many2One)
  • TO l-interface (comprises vserver, Many2Many)
  • TO pserver (Many2One)
  • TO volume (comprises vserver, Many2Many)
  • TO vnfc (Many2Many)
  • TO snapshot (One2One)
  • TO vf-module (Many2One)
  • FROM generic-vnf
  • FROM tenant (is composed of vserver)
  • FROM vce
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
is-closed-loop-disabled: boolean
resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

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

zone: object

A zone is a grouping of assets in a location homing to the same connections into the CBB

  • TO complex (Many2One)
  • FROM cloud-region
  • FROM pserver
  • FROM pnf
  • FROM service-instance
zone-id: string

Code assigned by AIC to the zone

zone-name: string

English name associated with the zone

design-type: string

Design of zone [Medium/Large?]

zone-context: string

Context of zone [production/test]

status: string

Status of a zone.

resource-version: string

Concurrency value

relationship-list: object[]
relationship

zones: object

Collection of zones

zone: object[]
zone