Active and Available Inventory REST API.

Version: v14



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

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

You may obtain a copy of the License at

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

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

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

Schemes: https

Summary

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

Tag: CloudInfrastructure

OperationDescription
GET /cloud-infrastructure/cloud-regions

returns cloud-regions

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

returns cloud-region

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

create or update an existing cloud-region

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}

update an existing cloud-region

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}

delete an existing cloud-region

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

returns availability-zones

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

returns availability-zone

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

create or update an existing availability-zone

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

update an existing availability-zone

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

delete an existing availability-zone

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

see node definition for valid relationships

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship

delete an existing relationship

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

returns dvs-switches

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

returns dvs-switch

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

create or update an existing dvs-switch

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

update an existing dvs-switch

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

delete an existing dvs-switch

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

see node definition for valid relationships

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship

delete an existing relationship

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

returns esr-system-info-list

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

returns esr-system-info

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

create or update an existing esr-system-info

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

update an existing esr-system-info

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

delete an existing esr-system-info

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

see node definition for valid relationships

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

delete an existing relationship

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

returns flavors

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

returns flavor

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

create or update an existing flavor

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

update an existing flavor

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

delete an existing flavor

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

returns hpa-capabilities

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

returns hpa-capability

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

create or update an existing hpa-capability

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

update an existing hpa-capability

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

delete an existing hpa-capability

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

returns hpa-feature-attributes

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

create or update an existing hpa-feature-attributes

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

update an existing hpa-feature-attributes

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

delete an existing hpa-feature-attributes

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

see node definition for valid relationships

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

delete an existing relationship

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

see node definition for valid relationships

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship

delete an existing relationship

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

see node definition for valid relationships

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship

delete an existing relationship

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

returns group-assignments

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

returns group-assignment

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

create or update an existing group-assignment

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

update an existing group-assignment

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

delete an existing group-assignment

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

see node definition for valid relationships

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship

delete an existing relationship

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

returns hpa-capabilities

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

returns hpa-capability

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

create or update an existing hpa-capability

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

update an existing hpa-capability

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

delete an existing hpa-capability

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

returns hpa-feature-attributes

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

create or update an existing hpa-feature-attributes

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

update an existing hpa-feature-attributes

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

delete an existing hpa-feature-attributes

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

see node definition for valid relationships

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}/relationship-list/relationship

delete an existing relationship

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

see node definition for valid relationships

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship

delete an existing relationship

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

returns images

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

returns image

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

create or update an existing image

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

update an existing image

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

delete an existing image

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

returns metadata

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

returns metadatum

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

create or update an existing metadatum

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

update an existing metadatum

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

delete an existing metadatum

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

see node definition for valid relationships

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship

delete an existing relationship

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

returns oam-networks

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

returns oam-network

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

create or update an existing oam-network

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

update an existing oam-network

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

delete an existing oam-network

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

see node definition for valid relationships

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship

delete an existing relationship

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

see node definition for valid relationships

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship

delete an existing relationship

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

returns snapshots

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

returns snapshot

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

create or update an existing snapshot

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

update an existing snapshot

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

delete an existing snapshot

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

see node definition for valid relationships

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship

delete an existing relationship

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

returns tenants

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

returns tenant

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

create or update an existing tenant

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

update an existing tenant

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

delete an existing tenant

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

returns nos-servers

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

returns nos-server

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

create or update an existing nos-server

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

update an existing nos-server

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

delete an existing nos-server

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

see node definition for valid relationships

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/nos-servers/nos-server/{nos-server-id}/relationship-list/relationship

delete an existing relationship

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

see node definition for valid relationships

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship

delete an existing relationship

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

returns vservers

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

returns vserver

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

create or update an existing vserver

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

update an existing vserver

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

delete an existing vserver

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

returns l-interfaces

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

returns l-interface

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

create or update an existing l-interface

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

update an existing l-interface

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

delete an existing l-interface

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

returns l3-interface-ipv4-address-list

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

create or update an existing l3-interface-ipv4-address-list

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

update an existing l3-interface-ipv4-address-list

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

delete an existing l3-interface-ipv4-address-list

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

see node definition for valid relationships

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

delete an existing relationship

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

returns l3-interface-ipv6-address-list

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

create or update an existing l3-interface-ipv6-address-list

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

update an existing l3-interface-ipv6-address-list

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

delete an existing l3-interface-ipv6-address-list

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

see node definition for valid relationships

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

delete an existing relationship

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

see node definition for valid relationships

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

delete an existing relationship

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

returns sriov-vfs

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

returns sriov-vf

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

create or update an existing sriov-vf

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

update an existing sriov-vf

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

delete an existing sriov-vf

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

see node definition for valid relationships

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

delete an existing relationship

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

returns vlans

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

returns vlan

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

create or update an existing vlan

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

update an existing vlan

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

delete an existing vlan

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

returns l3-interface-ipv4-address-list

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

create or update an existing l3-interface-ipv4-address-list

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

update an existing l3-interface-ipv4-address-list

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

delete an existing l3-interface-ipv4-address-list

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

see node definition for valid relationships

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

delete an existing relationship

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

returns l3-interface-ipv6-address-list

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

create or update an existing l3-interface-ipv6-address-list

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

update an existing l3-interface-ipv6-address-list

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

delete an existing l3-interface-ipv6-address-list

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

see node definition for valid relationships

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

delete an existing relationship

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

see node definition for valid relationships

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

delete an existing relationship

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

see node definition for valid relationships

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship

delete an existing relationship

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

returns volumes

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

returns volume

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

create or update an existing volume

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

update an existing volume

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

delete an existing volume

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

see node definition for valid relationships

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship

delete an existing relationship

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

returns vip-ipv4-address-list

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

create or update an existing vip-ipv4-address-list

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

update an existing vip-ipv4-address-list

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

delete an existing vip-ipv4-address-list

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

see node definition for valid relationships

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship

delete an existing relationship

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

returns vip-ipv6-address-list

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

create or update an existing vip-ipv6-address-list

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

update an existing vip-ipv6-address-list

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

delete an existing vip-ipv6-address-list

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

see node definition for valid relationships

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship

delete an existing relationship

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

returns volume-groups

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

returns volume-group

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

create or update an existing volume-group

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

update an existing volume-group

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

delete an existing volume-group

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

see node definition for valid relationships

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship

delete an existing relationship

GET /cloud-infrastructure/complexes

returns complexes

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

returns complex

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

create or update an existing complex

PATCH /cloud-infrastructure/complexes/complex/{physical-location-id}

update an existing complex

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

delete an existing complex

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

returns ctag-pools

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

returns ctag-pool

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

create or update an existing ctag-pool

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

update an existing ctag-pool

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

delete an existing ctag-pool

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

see node definition for valid relationships

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

delete an existing relationship

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

PATCH /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

update an existing network-profile

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

delete an existing network-profile

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

see node definition for valid relationships

DELETE /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship

delete an existing relationship

GET /cloud-infrastructure/network-technologies

returns network-technologies

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

returns network-technology

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

create or update an existing network-technology

PATCH /cloud-infrastructure/network-technologies/network-technology/{network-technology-id}

update an existing network-technology

DELETE /cloud-infrastructure/network-technologies/network-technology/{network-technology-id}

delete an existing network-technology

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

see node definition for valid relationships

DELETE /cloud-infrastructure/network-technologies/network-technology/{network-technology-id}/relationship-list/relationship

delete an existing relationship

GET /cloud-infrastructure/operational-environments

returns operational-environments

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

returns operational-environment

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

create or update an existing operational-environment

PATCH /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}

update an existing operational-environment

DELETE /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}

delete an existing operational-environment

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

see node definition for valid relationships

DELETE /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}/relationship-list/relationship

delete an existing relationship

GET /cloud-infrastructure/pservers

returns pservers

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

returns pserver

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

create or update an existing pserver

PATCH /cloud-infrastructure/pservers/pserver/{hostname}

update an existing pserver

DELETE /cloud-infrastructure/pservers/pserver/{hostname}

delete an existing pserver

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

returns hpa-capacity

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

create or update an existing hpa-capacity

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

update an existing hpa-capacity

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

delete an existing hpa-capacity

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

see node definition for valid relationships

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/hpa-capacity/{hpa-capacity-key}/relationship-list/relationship

delete an existing relationship

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

returns lag-interfaces

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

returns lag-interface

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

create or update an existing lag-interface

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

update an existing lag-interface

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

delete an existing lag-interface

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

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

update an existing l-interface

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

PATCH /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}

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

PATCH /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}

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

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

update an existing sriov-vf

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

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

update an existing vlan

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

PATCH /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}

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

PATCH /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}

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

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

update an existing p-interface

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

delete an existing p-interface

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

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

update an existing l-interface

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

PATCH /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}

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

PATCH /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}

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

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

update an existing sriov-vf

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

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

update an existing vlan

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

PATCH /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}

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

PATCH /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}

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

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

update an existing sriov-pf

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

delete an existing sriov-pf

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

see node definition for valid relationships

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

delete an existing relationship

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

see node definition for valid relationships

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship

delete an existing relationship

GET /cloud-infrastructure/virtual-data-centers

returns virtual-data-centers

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

returns virtual-data-center

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

create or update an existing virtual-data-center

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

update an existing virtual-data-center

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

delete an existing virtual-data-center

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

see node definition for valid relationships

DELETE /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship

delete an existing relationship

Tag: Business

OperationDescription
GET /business/connectors

returns connectors

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

returns connector

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

create or update an existing connector

PATCH /business/connectors/connector/{resource-instance-id}

update an existing connector

DELETE /business/connectors/connector/{resource-instance-id}

delete an existing connector

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

returns metadata

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

returns metadatum

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

create or update an existing metadatum

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

update an existing metadatum

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

delete an existing metadatum

PUT /business/connectors/connector/{resource-instance-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /business/connectors/connector/{resource-instance-id}/relationship-list/relationship

delete an existing relationship

GET /business/customers

returns customers

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

returns customer

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

create or update an existing customer

PATCH /business/customers/customer/{global-customer-id}

update an existing customer

DELETE /business/customers/customer/{global-customer-id}

delete an existing customer

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

see node definition for valid relationships

DELETE /business/customers/customer/{global-customer-id}/relationship-list/relationship

delete an existing relationship

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

returns service-subscriptions

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

returns service-subscription

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

create or update an existing service-subscription

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

update an existing service-subscription

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

delete an existing service-subscription

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

see node definition for valid relationships

DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship

delete an existing relationship

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

returns service-instances

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

returns service-instance

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

create or update an existing service-instance

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

update an existing service-instance

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

delete an existing service-instance

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

returns allotted-resources

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

returns allotted-resource

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

create or update an existing allotted-resource

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

update an existing allotted-resource

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

delete an existing allotted-resource

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

see node definition for valid relationships

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

delete an existing relationship

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

returns tunnel-xconnects

GET /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{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

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

update an existing tunnel-xconnect

DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{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

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

update an existing metadatum

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

delete an existing metadatum

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

see node definition for valid relationships

DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship

delete an existing relationship

GET /business/lines-of-business

returns lines-of-business

GET /business/lines-of-business/line-of-business/{line-of-business-name}

returns line-of-business

PUT /business/lines-of-business/line-of-business/{line-of-business-name}

create or update an existing line-of-business

PATCH /business/lines-of-business/line-of-business/{line-of-business-name}

update an existing line-of-business

DELETE /business/lines-of-business/line-of-business/{line-of-business-name}

delete an existing line-of-business

PUT /business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship

see node definition for valid relationships

DELETE /business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship

delete an existing relationship

GET /business/owning-entities

returns owning-entities

GET /business/owning-entities/owning-entity/{owning-entity-id}

returns owning-entity

PUT /business/owning-entities/owning-entity/{owning-entity-id}

create or update an existing owning-entity

PATCH /business/owning-entities/owning-entity/{owning-entity-id}

update an existing owning-entity

DELETE /business/owning-entities/owning-entity/{owning-entity-id}

delete an existing owning-entity

PUT /business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship

delete an existing relationship

GET /business/platforms

returns platforms

GET /business/platforms/platform/{platform-name}

returns platform

PUT /business/platforms/platform/{platform-name}

create or update an existing platform

PATCH /business/platforms/platform/{platform-name}

update an existing platform

DELETE /business/platforms/platform/{platform-name}

delete an existing platform

PUT /business/platforms/platform/{platform-name}/relationship-list/relationship

see node definition for valid relationships

DELETE /business/platforms/platform/{platform-name}/relationship-list/relationship

delete an existing relationship

GET /business/projects

returns projects

GET /business/projects/project/{project-name}

returns project

PUT /business/projects/project/{project-name}

create or update an existing project

PATCH /business/projects/project/{project-name}

update an existing project

DELETE /business/projects/project/{project-name}

delete an existing project

PUT /business/projects/project/{project-name}/relationship-list/relationship

see node definition for valid relationships

DELETE /business/projects/project/{project-name}/relationship-list/relationship

delete an existing relationship

GET /business/sp-partners

returns sp-partners

GET /business/sp-partners/sp-partner/{sp-partner-id}

returns sp-partner

PUT /business/sp-partners/sp-partner/{sp-partner-id}

create or update an existing sp-partner

PATCH /business/sp-partners/sp-partner/{sp-partner-id}

update an existing sp-partner

DELETE /business/sp-partners/sp-partner/{sp-partner-id}

delete an existing sp-partner

PUT /business/sp-partners/sp-partner/{sp-partner-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /business/sp-partners/sp-partner/{sp-partner-id}/relationship-list/relationship

delete an existing relationship

Tag: ServiceDesignAndCreation

OperationDescription
GET /service-design-and-creation/models

returns models

GET /service-design-and-creation/models/model/{model-invariant-id}

returns model

PUT /service-design-and-creation/models/model/{model-invariant-id}

create or update an existing model

PATCH /service-design-and-creation/models/model/{model-invariant-id}

update an existing model

DELETE /service-design-and-creation/models/model/{model-invariant-id}

delete an existing model

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers

returns model-vers

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

returns model-ver

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

create or update an existing model-ver

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

update an existing model-ver

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

delete an existing model-ver

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata

returns metadata

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

returns metadatum

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

create or update an existing metadatum

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

update an existing metadatum

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

delete an existing metadatum

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements

returns model-elements

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}

returns model-element

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}

create or update an existing model-element

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}

update an existing model-element

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}

delete an existing model-element

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints

returns model-constraints

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

returns model-constraint

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

create or update an existing model-constraint

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

update an existing model-constraint

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

delete an existing model-constraint

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets

returns constrained-element-sets

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

returns constrained-element-set

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

create or update an existing constrained-element-set

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

update an existing constrained-element-set

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

delete an existing constrained-element-set

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets

returns element-choice-sets

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

returns element-choice-set

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

create or update an existing element-choice-set

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

update an existing element-choice-set

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

delete an existing element-choice-set

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship

see node definition for valid relationships

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship

delete an existing relationship

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/relationship-list/relationship

see node definition for valid relationships

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/relationship-list/relationship

delete an existing relationship

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship

see node definition for valid relationships

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship

delete an existing relationship

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship

delete an existing relationship

PUT /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship

delete an existing relationship

GET /service-design-and-creation/named-queries

returns named-queries

GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}

returns named-query

PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}

create or update an existing named-query

PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}

update an existing named-query

DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}

delete an existing named-query

GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements

returns named-query-elements

GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}

returns named-query-element

PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}

create or update an existing named-query-element

PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}

update an existing named-query-element

DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}

delete an existing named-query-element

GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints

returns property-constraints

GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}

returns property-constraint

PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}

create or update an existing property-constraint

PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}

update an existing property-constraint

DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}

delete an existing property-constraint

GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups

returns related-lookups

GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}

returns related-lookup

PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}

create or update an existing related-lookup

PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}

update an existing related-lookup

DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}

delete an existing related-lookup

PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}/relationship-list/relationship

see node definition for valid relationships

DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}/relationship-list/relationship

delete an existing relationship

PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship

see node definition for valid relationships

DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship

delete an existing relationship

PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship

see node definition for valid relationships

DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship

delete an existing relationship

GET /service-design-and-creation/service-capabilities

returns service-capabilities

GET /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

returns service-capability

PUT /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

create or update an existing service-capability

PATCH /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

update an existing service-capability

DELETE /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

delete an existing service-capability

PUT /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship

see node definition for valid relationships

DELETE /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship

delete an existing relationship

GET /service-design-and-creation/services

returns services

GET /service-design-and-creation/services/service/{service-id}

returns service

PUT /service-design-and-creation/services/service/{service-id}

create or update an existing service

PATCH /service-design-and-creation/services/service/{service-id}

update an existing service

DELETE /service-design-and-creation/services/service/{service-id}

delete an existing service

PUT /service-design-and-creation/services/service/{service-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /service-design-and-creation/services/service/{service-id}/relationship-list/relationship

delete an existing relationship

GET /service-design-and-creation/vnf-images

returns vnf-images

GET /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

returns vnf-image

PUT /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

create or update an existing vnf-image

PATCH /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

update an existing vnf-image

DELETE /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

delete an existing vnf-image

PUT /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship

see node definition for valid relationships

DELETE /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship

delete an existing relationship

Tag: Network

OperationDescription
GET /network/collections

returns collections

GET /network/collections/collection/{collection-id}

returns collection

PUT /network/collections/collection/{collection-id}

create or update an existing collection

PATCH /network/collections/collection/{collection-id}

update an existing collection

DELETE /network/collections/collection/{collection-id}

delete an existing collection

PUT /network/collections/collection/{collection-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/collections/collection/{collection-id}/relationship-list/relationship

delete an existing relationship

GET /network/configurations

returns configurations

GET /network/configurations/configuration/{configuration-id}

returns configuration

PUT /network/configurations/configuration/{configuration-id}

create or update an existing configuration

PATCH /network/configurations/configuration/{configuration-id}

update an existing configuration

DELETE /network/configurations/configuration/{configuration-id}

delete an existing configuration

GET /network/configurations/configuration/{configuration-id}/evcs

returns evcs

GET /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}

returns evc

PUT /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}

create or update an existing evc

PATCH /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}

update an existing evc

DELETE /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}

delete an existing evc

PUT /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}/relationship-list/relationship

delete an existing relationship

GET /network/configurations/configuration/{configuration-id}/forwarder-evcs

returns forwarder-evcs

GET /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}

returns forwarder-evc

PUT /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}

create or update an existing forwarder-evc

PATCH /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}

update an existing forwarder-evc

DELETE /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}

delete an existing forwarder-evc

PUT /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/relationship-list/relationship

delete an existing relationship

GET /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/vlan-mappings

returns vlan-mappings

GET /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/vlan-mappings/vlan-mapping/{vlan-mapping-id}

returns vlan-mapping

PUT /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/vlan-mappings/vlan-mapping/{vlan-mapping-id}

create or update an existing vlan-mapping

PATCH /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/vlan-mappings/vlan-mapping/{vlan-mapping-id}

update an existing vlan-mapping

DELETE /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/vlan-mappings/vlan-mapping/{vlan-mapping-id}

delete an existing vlan-mapping

PUT /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/vlan-mappings/vlan-mapping/{vlan-mapping-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/vlan-mappings/vlan-mapping/{vlan-mapping-id}/relationship-list/relationship

delete an existing relationship

GET /network/configurations/configuration/{configuration-id}/metadata

returns metadata

GET /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}

returns metadatum

PUT /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}

create or update an existing metadatum

PATCH /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}

update an existing metadatum

DELETE /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}

delete an existing metadatum

PUT /network/configurations/configuration/{configuration-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/configurations/configuration/{configuration-id}/relationship-list/relationship

delete an existing relationship

GET /network/connectivities

returns connectivities

GET /network/connectivities/connectivity/{connectivity-id}

returns connectivity

PUT /network/connectivities/connectivity/{connectivity-id}

create or update an existing connectivity

PATCH /network/connectivities/connectivity/{connectivity-id}

update an existing connectivity

DELETE /network/connectivities/connectivity/{connectivity-id}

delete an existing connectivity

PUT /network/connectivities/connectivity/{connectivity-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/connectivities/connectivity/{connectivity-id}/relationship-list/relationship

delete an existing relationship

GET /network/devices

returns devices

GET /network/devices/device/{device-id}

returns device

PUT /network/devices/device/{device-id}

create or update an existing device

PATCH /network/devices/device/{device-id}

update an existing device

DELETE /network/devices/device/{device-id}

delete an existing device

PUT /network/devices/device/{device-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/devices/device/{device-id}/relationship-list/relationship

delete an existing relationship

GET /network/ext-aai-networks

returns ext-aai-networks

GET /network/ext-aai-networks/ext-aai-network/{aai-id}

returns ext-aai-network

PUT /network/ext-aai-networks/ext-aai-network/{aai-id}

create or update an existing ext-aai-network

PATCH /network/ext-aai-networks/ext-aai-network/{aai-id}

update an existing ext-aai-network

DELETE /network/ext-aai-networks/ext-aai-network/{aai-id}

delete an existing ext-aai-network

GET /network/ext-aai-networks/ext-aai-network/{aai-id}/esr-system-info/{esr-system-info-id}

returns esr-system-info

PUT /network/ext-aai-networks/ext-aai-network/{aai-id}/esr-system-info/{esr-system-info-id}

create or update an existing esr-system-info

PATCH /network/ext-aai-networks/ext-aai-network/{aai-id}/esr-system-info/{esr-system-info-id}

update an existing esr-system-info

DELETE /network/ext-aai-networks/ext-aai-network/{aai-id}/esr-system-info/{esr-system-info-id}

delete an existing esr-system-info

PUT /network/ext-aai-networks/ext-aai-network/{aai-id}/esr-system-info/{esr-system-info-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/ext-aai-networks/ext-aai-network/{aai-id}/esr-system-info/{esr-system-info-id}/relationship-list/relationship

delete an existing relationship

PUT /network/ext-aai-networks/ext-aai-network/{aai-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/ext-aai-networks/ext-aai-network/{aai-id}/relationship-list/relationship

delete an existing relationship

GET /network/forwarding-paths

returns forwarding-paths

GET /network/forwarding-paths/forwarding-path/{forwarding-path-id}

returns forwarding-path

PUT /network/forwarding-paths/forwarding-path/{forwarding-path-id}

create or update an existing forwarding-path

PATCH /network/forwarding-paths/forwarding-path/{forwarding-path-id}

update an existing forwarding-path

DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}

delete an existing forwarding-path

GET /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders

returns forwarders

GET /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}

returns forwarder

PUT /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}

create or update an existing forwarder

PATCH /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}

update an existing forwarder

DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}

delete an existing forwarder

PUT /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}/relationship-list/relationship

delete an existing relationship

PUT /network/forwarding-paths/forwarding-path/{forwarding-path-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}/relationship-list/relationship

delete an existing relationship

GET /network/generic-vnfs

returns generic-vnfs

GET /network/generic-vnfs/generic-vnf/{vnf-id}

returns generic-vnf

PUT /network/generic-vnfs/generic-vnf/{vnf-id}

create or update an existing generic-vnf

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}

update an existing generic-vnf

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}

delete an existing generic-vnf

GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements

returns entitlements

GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

returns entitlement

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

create or update an existing entitlement

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

update an existing entitlement

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

delete an existing entitlement

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

delete an existing relationship

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces

returns l-interfaces

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

returns l-interface

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

create or update an existing l-interface

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

update an existing l-interface

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

delete an existing l-interface

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs

returns sriov-vfs

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

returns sriov-vf

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

create or update an existing sriov-vf

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

update an existing sriov-vf

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

delete an existing sriov-vf

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

see node definition for valid relationships

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

delete an existing relationship

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans

returns vlans

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

returns vlan

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

update an existing vlan

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

delete an existing vlan

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

delete an existing relationship

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces

returns lag-interfaces

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

returns lag-interface

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

create or update an existing lag-interface

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

update an existing lag-interface

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

delete an existing lag-interface

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

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

update an existing l-interface

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

PATCH /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}

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

PATCH /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}

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

PATCH /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}

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

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

update an existing vlan

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

PATCH /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}

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

PATCH /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}

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

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

update an existing license

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

delete an existing license

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

delete an existing relationship

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship

delete an existing relationship

GET /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules

returns vf-modules

GET /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

returns vf-module

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

create or update an existing vf-module

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

update an existing vf-module

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

delete an existing vf-module

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship

delete an existing relationship

GET /network/instance-groups

returns instance-groups

GET /network/instance-groups/instance-group/{id}

returns instance-group

PUT /network/instance-groups/instance-group/{id}

create or update an existing instance-group

PATCH /network/instance-groups/instance-group/{id}

update an existing instance-group

DELETE /network/instance-groups/instance-group/{id}

delete an existing instance-group

PUT /network/instance-groups/instance-group/{id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/instance-groups/instance-group/{id}/relationship-list/relationship

delete an existing relationship

GET /network/ipsec-configurations

returns ipsec-configurations

GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

returns ipsec-configuration

PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

create or update an existing ipsec-configuration

PATCH /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

update an existing ipsec-configuration

DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

delete an existing ipsec-configuration

PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship

delete an existing relationship

GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers

returns vig-servers

GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

returns vig-server

PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

create or update an existing vig-server

PATCH /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

update an existing vig-server

DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

delete an existing vig-server

PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship

delete an existing relationship

GET /network/l3-networks

returns l3-networks

GET /network/l3-networks/l3-network/{network-id}

returns l3-network

PUT /network/l3-networks/l3-network/{network-id}

create or update an existing l3-network

PATCH /network/l3-networks/l3-network/{network-id}

update an existing l3-network

DELETE /network/l3-networks/l3-network/{network-id}

delete an existing l3-network

GET /network/l3-networks/l3-network/{network-id}/ctag-assignments

returns ctag-assignments

GET /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

returns ctag-assignment

PUT /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

create or update an existing ctag-assignment

PATCH /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

update an existing ctag-assignment

DELETE /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

delete an existing ctag-assignment

PUT /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship

delete an existing relationship

PUT /network/l3-networks/l3-network/{network-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/l3-networks/l3-network/{network-id}/relationship-list/relationship

delete an existing relationship

GET /network/l3-networks/l3-network/{network-id}/segmentation-assignments

returns segmentation-assignments

GET /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

returns segmentation-assignment

PUT /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

create or update an existing segmentation-assignment

PATCH /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

update an existing segmentation-assignment

DELETE /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

delete an existing segmentation-assignment

PUT /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship

delete an existing relationship

GET /network/l3-networks/l3-network/{network-id}/subnets

returns subnets

GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

returns subnet

PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

create or update an existing subnet

PATCH /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

update an existing subnet

DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

delete an existing subnet

GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes

returns host-routes

GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

returns host-route

PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

create or update an existing host-route

PATCH /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

update an existing host-route

DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

delete an existing host-route

PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship

delete an existing relationship

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

PATCH /network/lag-links/lag-link/{link-name}

update an existing lag-link

DELETE /network/lag-links/lag-link/{link-name}

delete an existing lag-link

PUT /network/lag-links/lag-link/{link-name}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/lag-links/lag-link/{link-name}/relationship-list/relationship

delete an existing relationship

GET /network/lan-port-configs

returns lan-port-configs

GET /network/lan-port-configs/lan-port-config/{lan-port-config-id}

returns lan-port-config

PUT /network/lan-port-configs/lan-port-config/{lan-port-config-id}

create or update an existing lan-port-config

PATCH /network/lan-port-configs/lan-port-config/{lan-port-config-id}

update an existing lan-port-config

DELETE /network/lan-port-configs/lan-port-config/{lan-port-config-id}

delete an existing lan-port-config

GET /network/lan-port-configs/lan-port-config/{lan-port-config-id}/dhcp-services

returns dhcp-services

GET /network/lan-port-configs/lan-port-config/{lan-port-config-id}/dhcp-services/dhcp-service/{dhcp-service-id}

returns dhcp-service

PUT /network/lan-port-configs/lan-port-config/{lan-port-config-id}/dhcp-services/dhcp-service/{dhcp-service-id}

create or update an existing dhcp-service

PATCH /network/lan-port-configs/lan-port-config/{lan-port-config-id}/dhcp-services/dhcp-service/{dhcp-service-id}

update an existing dhcp-service

DELETE /network/lan-port-configs/lan-port-config/{lan-port-config-id}/dhcp-services/dhcp-service/{dhcp-service-id}

delete an existing dhcp-service

PUT /network/lan-port-configs/lan-port-config/{lan-port-config-id}/dhcp-services/dhcp-service/{dhcp-service-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/lan-port-configs/lan-port-config/{lan-port-config-id}/dhcp-services/dhcp-service/{dhcp-service-id}/relationship-list/relationship

delete an existing relationship

PUT /network/lan-port-configs/lan-port-config/{lan-port-config-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/lan-port-configs/lan-port-config/{lan-port-config-id}/relationship-list/relationship

delete an existing relationship

GET /network/logical-links

returns logical-links

GET /network/logical-links/logical-link/{link-name}

returns logical-link

PUT /network/logical-links/logical-link/{link-name}

create or update an existing logical-link

PATCH /network/logical-links/logical-link/{link-name}

update an existing logical-link

DELETE /network/logical-links/logical-link/{link-name}

delete an existing logical-link

PUT /network/logical-links/logical-link/{link-name}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/logical-links/logical-link/{link-name}/relationship-list/relationship

delete an existing relationship

GET /network/multicast-configurations

returns multicast-configurations

GET /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

returns multicast-configuration

PUT /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

create or update an existing multicast-configuration

PATCH /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

update an existing multicast-configuration

DELETE /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

delete an existing multicast-configuration

PUT /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship

delete an existing relationship

GET /network/network-policies

returns network-policies

GET /network/network-policies/network-policy/{network-policy-id}

returns network-policy

PUT /network/network-policies/network-policy/{network-policy-id}

create or update an existing network-policy

PATCH /network/network-policies/network-policy/{network-policy-id}

update an existing network-policy

DELETE /network/network-policies/network-policy/{network-policy-id}

delete an existing network-policy

PUT /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship

delete an existing relationship

GET /network/network-resources

returns network-resources

GET /network/network-resources/network-resource/{network-id}

returns network-resource

PUT /network/network-resources/network-resource/{network-id}

create or update an existing network-resource

PATCH /network/network-resources/network-resource/{network-id}

update an existing network-resource

DELETE /network/network-resources/network-resource/{network-id}

delete an existing network-resource

PUT /network/network-resources/network-resource/{network-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/network-resources/network-resource/{network-id}/relationship-list/relationship

delete an existing relationship

GET /network/newvces

returns newvces

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

returns newvce

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

create or update an existing newvce

PATCH /network/newvces/newvce/{vnf-id2}

update an existing newvce

DELETE /network/newvces/newvce/{vnf-id2}

delete an existing newvce

GET /network/newvces/newvce/{vnf-id2}/l-interfaces

returns l-interfaces

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

returns l-interface

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

create or update an existing l-interface

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

update an existing l-interface

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

delete an existing l-interface

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

delete an existing relationship

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs

returns sriov-vfs

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

returns sriov-vf

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

create or update an existing sriov-vf

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

update an existing sriov-vf

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

delete an existing sriov-vf

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

delete an existing relationship

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans

returns vlans

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

returns vlan

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

update an existing vlan

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

delete an existing vlan

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

delete an existing relationship

PUT /network/newvces/newvce/{vnf-id2}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/newvces/newvce/{vnf-id2}/relationship-list/relationship

delete an existing relationship

GET /network/physical-links

returns physical-links

GET /network/physical-links/physical-link/{link-name}

returns physical-link

PUT /network/physical-links/physical-link/{link-name}

create or update an existing physical-link

PATCH /network/physical-links/physical-link/{link-name}

update an existing physical-link

DELETE /network/physical-links/physical-link/{link-name}

delete an existing physical-link

PUT /network/physical-links/physical-link/{link-name}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/physical-links/physical-link/{link-name}/relationship-list/relationship

delete an existing relationship

GET /network/pnfs

returns pnfs

GET /network/pnfs/pnf/{pnf-name}

returns pnf

PUT /network/pnfs/pnf/{pnf-name}

create or update an existing pnf

PATCH /network/pnfs/pnf/{pnf-name}

update an existing pnf

DELETE /network/pnfs/pnf/{pnf-name}

delete an existing pnf

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces

returns lag-interfaces

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

returns lag-interface

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

create or update an existing lag-interface

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

update an existing lag-interface

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

delete an existing lag-interface

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

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

update an existing l-interface

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{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

PATCH /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}

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

PATCH /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}

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

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

update an existing sriov-vf

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{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

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

update an existing vlan

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{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

PATCH /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}

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

PATCH /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}

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

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

update an existing p-interface

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

delete an existing p-interface

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

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

update an existing l-interface

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{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

PATCH /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}

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

PATCH /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}

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

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

update an existing sriov-vf

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{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

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

update an existing vlan

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{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

PATCH /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}

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

PATCH /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}

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

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

update an existing sriov-pf

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

delete an existing sriov-pf

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

delete an existing relationship

PUT /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

delete an existing relationship

GET /network/pnfs/pnf/{pnf-name}/software-versions

returns software-versions

GET /network/pnfs/pnf/{pnf-name}/software-versions/software-version/{software-version-id}

returns software-version

PUT /network/pnfs/pnf/{pnf-name}/software-versions/software-version/{software-version-id}

create or update an existing software-version

PATCH /network/pnfs/pnf/{pnf-name}/software-versions/software-version/{software-version-id}

update an existing software-version

DELETE /network/pnfs/pnf/{pnf-name}/software-versions/software-version/{software-version-id}

delete an existing software-version

GET /network/route-table-references

returns route-table-references

GET /network/route-table-references/route-table-reference/{route-table-reference-id}

returns route-table-reference

PUT /network/route-table-references/route-table-reference/{route-table-reference-id}

create or update an existing route-table-reference

PATCH /network/route-table-references/route-table-reference/{route-table-reference-id}

update an existing route-table-reference

DELETE /network/route-table-references/route-table-reference/{route-table-reference-id}

delete an existing route-table-reference

PUT /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

delete an existing relationship

GET /network/sdwan-vpns

returns sdwan-vpns

GET /network/sdwan-vpns/sdwan-vpn/{sdwan-vpn-id}

returns sdwan-vpn

PUT /network/sdwan-vpns/sdwan-vpn/{sdwan-vpn-id}

create or update an existing sdwan-vpn

PATCH /network/sdwan-vpns/sdwan-vpn/{sdwan-vpn-id}

update an existing sdwan-vpn

DELETE /network/sdwan-vpns/sdwan-vpn/{sdwan-vpn-id}

delete an existing sdwan-vpn

PUT /network/sdwan-vpns/sdwan-vpn/{sdwan-vpn-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/sdwan-vpns/sdwan-vpn/{sdwan-vpn-id}/relationship-list/relationship

delete an existing relationship

GET /network/site-pair-sets

returns site-pair-sets

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}

returns site-pair-set

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}

create or update an existing site-pair-set

PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}

update an existing site-pair-set

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}

delete an existing site-pair-set

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship

delete an existing relationship

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances

returns routing-instances

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

returns routing-instance

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

create or update an existing routing-instance

PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

update an existing routing-instance

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

delete an existing routing-instance

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship

delete an existing relationship

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs

returns site-pairs

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}

returns site-pair

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}

create or update an existing site-pair

PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}

update an existing site-pair

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}

delete an existing site-pair

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service

returns classes-of-service

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}

returns class-of-service

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}

create or update an existing class-of-service

PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}

update an existing class-of-service

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}

delete an existing class-of-service

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}/relationship-list/relationship

delete an existing relationship

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/relationship-list/relationship

delete an existing relationship

GET /network/site-resources

returns site-resources

GET /network/site-resources/site-resource/{site-resource-id}

returns site-resource

PUT /network/site-resources/site-resource/{site-resource-id}

create or update an existing site-resource

PATCH /network/site-resources/site-resource/{site-resource-id}

update an existing site-resource

DELETE /network/site-resources/site-resource/{site-resource-id}

delete an existing site-resource

PUT /network/site-resources/site-resource/{site-resource-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/site-resources/site-resource/{site-resource-id}/relationship-list/relationship

delete an existing relationship

GET /network/vces

returns vces

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

returns vce

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

create or update an existing vce

PATCH /network/vces/vce/{vnf-id}

update an existing vce

DELETE /network/vces/vce/{vnf-id}

delete an existing vce

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

returns entitlements

GET /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

returns entitlement

PUT /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

create or update an existing entitlement

PATCH /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

update an existing entitlement

DELETE /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

delete an existing entitlement

PUT /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

delete an existing relationship

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

returns licenses

GET /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

returns license

PUT /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

create or update an existing license

PATCH /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

update an existing license

DELETE /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

delete an existing license

PUT /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

delete an existing relationship

GET /network/vces/vce/{vnf-id}/port-groups

returns port-groups

GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

returns port-group

PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

create or update an existing port-group

PATCH /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

update an existing port-group

DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

delete an existing port-group

GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags

returns cvlan-tags

GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

returns cvlan-tag-entry

PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

create or update an existing cvlan-tag-entry

PATCH /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

update an existing cvlan-tag-entry

DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

delete an existing cvlan-tag-entry

PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship

delete an existing relationship

PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship

delete an existing relationship

PUT /network/vces/vce/{vnf-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/vces/vce/{vnf-id}/relationship-list/relationship

delete an existing relationship

GET /network/vlan-tags

returns vlan-tags

GET /network/vlan-tags/vlan-tag/{vlan-tag-id}

returns vlan-tag

PUT /network/vlan-tags/vlan-tag/{vlan-tag-id}

create or update an existing vlan-tag

PATCH /network/vlan-tags/vlan-tag/{vlan-tag-id}

update an existing vlan-tag

DELETE /network/vlan-tags/vlan-tag/{vlan-tag-id}

delete an existing vlan-tag

PUT /network/vlan-tags/vlan-tag/{vlan-tag-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/vlan-tags/vlan-tag/{vlan-tag-id}/relationship-list/relationship

delete an existing relationship

GET /network/vnfcs

returns vnfcs

GET /network/vnfcs/vnfc/{vnfc-name}

returns vnfc

PUT /network/vnfcs/vnfc/{vnfc-name}

create or update an existing vnfc

PATCH /network/vnfcs/vnfc/{vnfc-name}

update an existing vnfc

DELETE /network/vnfcs/vnfc/{vnfc-name}

delete an existing vnfc

GET /network/vnfcs/vnfc/{vnfc-name}/cps

returns cps

GET /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}

returns cp

PUT /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}

create or update an existing cp

PATCH /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}

update an existing cp

DELETE /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}

delete an existing cp

GET /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list

PUT /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list

PATCH /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list

DELETE /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list

PUT /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship

GET /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list

PUT /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list

PATCH /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list

DELETE /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list

PUT /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship

PUT /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/relationship-list/relationship

delete an existing relationship

GET /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

returns l3-interface-ipv4-address-list

PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

create or update an existing l3-interface-ipv4-address-list

PATCH /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list

DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

delete an existing l3-interface-ipv4-address-list

PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

delete an existing relationship

GET /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

returns l3-interface-ipv6-address-list

PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

create or update an existing l3-interface-ipv6-address-list

PATCH /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list

DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

delete an existing l3-interface-ipv6-address-list

PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

delete an existing relationship

PUT /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship

delete an existing relationship

GET /network/vpls-pes

returns vpls-pes

GET /network/vpls-pes/vpls-pe/{equipment-name}

returns vpls-pe

PUT /network/vpls-pes/vpls-pe/{equipment-name}

create or update an existing vpls-pe

PATCH /network/vpls-pes/vpls-pe/{equipment-name}

update an existing vpls-pe

DELETE /network/vpls-pes/vpls-pe/{equipment-name}

delete an existing vpls-pe

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces

returns lag-interfaces

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

returns lag-interface

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

create or update an existing lag-interface

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

update an existing lag-interface

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

delete an existing lag-interface

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

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

update an existing l-interface

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

PATCH /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}

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

PATCH /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}

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

PATCH /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}

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

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

update an existing vlan

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

PATCH /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}

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

PATCH /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}

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

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

update an existing p-interface

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

delete an existing p-interface

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

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

update an existing l-interface

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

PATCH /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}

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

PATCH /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}

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

PATCH /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}

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

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

update an existing vlan

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

PATCH /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}

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

PATCH /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}

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

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

update an existing sriov-pf

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

delete an existing sriov-pf

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

delete an existing relationship

PUT /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship

delete an existing relationship

GET /network/vpn-bindings

returns vpn-bindings

GET /network/vpn-bindings/vpn-binding/{vpn-id}

returns vpn-binding

PUT /network/vpn-bindings/vpn-binding/{vpn-id}

create or update an existing vpn-binding

PATCH /network/vpn-bindings/vpn-binding/{vpn-id}

update an existing vpn-binding

DELETE /network/vpn-bindings/vpn-binding/{vpn-id}

delete an existing vpn-binding

PUT /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship

delete an existing relationship

GET /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets

returns route-targets

GET /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

returns route-target

PUT /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

create or update an existing route-target

PATCH /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

update an existing route-target

DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

delete an existing route-target

PUT /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship

delete an existing relationship

GET /network/wan-port-configs

returns wan-port-configs

GET /network/wan-port-configs/wan-port-config/{wan-port-config-id}

returns wan-port-config

PUT /network/wan-port-configs/wan-port-config/{wan-port-config-id}

create or update an existing wan-port-config

PATCH /network/wan-port-configs/wan-port-config/{wan-port-config-id}

update an existing wan-port-config

DELETE /network/wan-port-configs/wan-port-config/{wan-port-config-id}

delete an existing wan-port-config

PUT /network/wan-port-configs/wan-port-config/{wan-port-config-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/wan-port-configs/wan-port-config/{wan-port-config-id}/relationship-list/relationship

delete an existing relationship

GET /network/zones

returns zones

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

returns zone

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

create or update an existing zone

PATCH /network/zones/zone/{zone-id}

update an existing zone

DELETE /network/zones/zone/{zone-id}

delete an existing zone

PUT /network/zones/zone/{zone-id}/relationship-list/relationship

see node definition for valid relationships

DELETE /network/zones/zone/{zone-id}/relationship-list/relationship

delete an existing relationship

Paths

returns connectors

GET /business/connectors

Tags: Business

returns connectors

resource-instance-id query string
model-invariant-id query string
model-version-id query string
widget-model-id query string
widget-model-version query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns connector

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

Tags: Business

returns connector

resource-instance-id

Unique id of resource instance.

path string

application/json application/xml

200 OK

successful operation

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.

resource-instance-id

Unique id of resource instance.

path string

application/json application/xml

default

Response codes found in response codes.

update an existing connector

PATCH /business/connectors/connector/{resource-instance-id}

Tags: Business

update an existing connector

application/json application/xml

connector object that needs to be updated.

resource-instance-id

Unique id of resource instance.

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing connector

DELETE /business/connectors/connector/{resource-instance-id}

Tags: Business

delete an existing connector

application/json application/xml

resource-instance-id

Unique id of resource instance.

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

returns metadata

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

Tags: Business

returns metadata

resource-instance-id

Unique id of resource instance.

path string
metaname query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns metadatum

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

Tags: Business

returns metadatum

resource-instance-id

Unique id of resource instance.

path string
metaname path string

application/json application/xml

200 OK

successful operation

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.

resource-instance-id

Unique id of resource instance.

path string
metaname path string

application/json application/xml

default

Response codes found in response codes.

update an existing metadatum

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

Tags: Business

update an existing metadatum

application/json application/xml

metadatum object that needs to be updated.

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.

resource-instance-id

Unique id of resource instance.

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /business/connectors/connector/{resource-instance-id}/relationship-list/relationship

Tags: Business

delete an existing relationship

application/json application/xml

resource-instance-id

Unique id of resource instance.

path string

application/json application/xml

default

Response codes found in response codes.

returns customers

GET /business/customers

Tags: Business

returns customers

global-customer-id query string
subscriber-name query string
subscriber-type query string

application/json application/xml

200 OK

successful operation

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing customer

PATCH /business/customers/customer/{global-customer-id}

Tags: Business

update an existing customer

application/json application/xml

customer object that needs to be updated.

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.

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
service-type query string

application/json application/xml

200 OK

successful operation

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing service-subscription

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

Tags: Business

update an existing service-subscription

application/json application/xml

service-subscription object that needs to be updated.

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.

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
service-instance-id query string
service-instance-name query string
environment-context query string
workload-context query string
model-invariant-id query string
model-version-id query string
widget-model-id query string
widget-model-version query string
service-instance-location-id query string
orchestration-status query string

application/json application/xml

200 OK

successful operation

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing service-instance

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

Tags: Business

update an existing service-instance

application/json application/xml

service-instance object that needs to be updated.

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
id query string
model-invariant-id query string
model-version-id query string
type query string
role query string
allotted-resource-name query string
access-provider-id query string
access-client-id query string
access-topology-id query string
access-node-id query string
access-ltp-id query string
vpn-name query string

application/json application/xml

200 OK

successful operation

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing allotted-resource

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

Tags: Business

update an existing allotted-resource

application/json application/xml

allotted-resource object that needs to be updated.

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.

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
id query string

application/json application/xml

200 OK

successful operation

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing tunnel-xconnect

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

Tags: Business

update an existing tunnel-xconnect

application/json application/xml

tunnel-xconnect object that needs to be updated.

global-customer-id

Global customer id used across 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.

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
metaname query string

application/json application/xml

200 OK

successful operation

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing metadatum

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

Tags: Business

update an existing metadatum

application/json application/xml

metadatum object that needs to be updated.

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.

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

line-of-business-name query string

application/json application/xml

200 OK

successful operation

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

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

Name of the line-of-business (product)

path string

application/json application/xml

default

Response codes found in response codes.

update an existing line-of-business

PATCH /business/lines-of-business/line-of-business/{line-of-business-name}

Tags: Business

update an existing line-of-business

application/json application/xml

line-of-business object that needs to be updated.

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.

line-of-business-name

Name of the line-of-business (product)

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship

Tags: Business

delete an existing relationship

application/json application/xml

line-of-business-name

Name of the line-of-business (product)

path string

application/json application/xml

default

Response codes found in response codes.

returns owning-entities

GET /business/owning-entities

Tags: Business

returns owning-entities

owning-entity-id query string
owning-entity-name query string

application/json application/xml

200 OK

successful operation

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

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

UUID of an owning entity

path string

application/json application/xml

default

Response codes found in response codes.

update an existing owning-entity

PATCH /business/owning-entities/owning-entity/{owning-entity-id}

Tags: Business

update an existing owning-entity

application/json application/xml

owning-entity object that needs to be updated.

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.

owning-entity-id

UUID of an owning entity

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship

Tags: Business

delete an existing relationship

application/json application/xml

owning-entity-id

UUID of an owning entity

path string

application/json application/xml

default

Response codes found in response codes.

returns platforms

GET /business/platforms

Tags: Business

returns platforms

platform-name query string

application/json application/xml

200 OK

successful operation

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

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

Name of the platform

path string

application/json application/xml

default

Response codes found in response codes.

update an existing platform

PATCH /business/platforms/platform/{platform-name}

Tags: Business

update an existing platform

application/json application/xml

platform object that needs to be updated.

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.

platform-name

Name of the platform

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /business/platforms/platform/{platform-name}/relationship-list/relationship

Tags: Business

delete an existing relationship

application/json application/xml

platform-name

Name of the platform

path string

application/json application/xml

default

Response codes found in response codes.

returns projects

GET /business/projects

Tags: Business

returns projects

project-name query string

application/json application/xml

200 OK

successful operation

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

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

Name of the project deploying a service

path string

application/json application/xml

default

Response codes found in response codes.

update an existing project

PATCH /business/projects/project/{project-name}

Tags: Business

update an existing project

application/json application/xml

project object that needs to be updated.

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.

project-name

Name of the project deploying a service

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /business/projects/project/{project-name}/relationship-list/relationship

Tags: Business

delete an existing relationship

application/json application/xml

project-name

Name of the project deploying a service

path string

application/json application/xml

default

Response codes found in response codes.

returns sp-partners

GET /business/sp-partners

Tags: Business

returns sp-partners

sp-partner-id query string
url query string
callsource query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns sp-partner

GET /business/sp-partners/sp-partner/{sp-partner-id}

Tags: Business

returns sp-partner

sp-partner-id

Uniquely identifies this sp-partner by id

path string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

create or update an existing sp-partner

PUT /business/sp-partners/sp-partner/{sp-partner-id}

Tags: Business

create or update an existing sp-partner

application/json application/xml

sp-partner object that needs to be created or updated.

sp-partner-id

Uniquely identifies this sp-partner by id

path string

application/json application/xml

default

Response codes found in response codes.

update an existing sp-partner

PATCH /business/sp-partners/sp-partner/{sp-partner-id}

Tags: Business

update an existing sp-partner

application/json application/xml

sp-partner object that needs to be updated.

sp-partner-id

Uniquely identifies this sp-partner by id

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing sp-partner

DELETE /business/sp-partners/sp-partner/{sp-partner-id}

Tags: Business

delete an existing sp-partner

application/json application/xml

sp-partner-id

Uniquely identifies this sp-partner by id

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /business/sp-partners/sp-partner/{sp-partner-id}/relationship-list/relationship

Tags: Business

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

sp-partner-id

Uniquely identifies this sp-partner by id

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /business/sp-partners/sp-partner/{sp-partner-id}/relationship-list/relationship

Tags: Business

delete an existing relationship

application/json application/xml

sp-partner-id

Uniquely identifies this sp-partner by id

path string

application/json application/xml

default

Response codes found in response codes.

returns cloud-regions

GET /cloud-infrastructure/cloud-regions

Tags: CloudInfrastructure

returns cloud-regions

cloud-owner query string
cloud-region-id query string
cloud-type query string
owner-defined-type query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns cloud-region

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

Tags: CloudInfrastructure

returns cloud-region

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string

application/json application/xml

200 OK

successful operation

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

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string

application/json application/xml

default

Response codes found in response codes.

update an existing cloud-region

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}

Tags: CloudInfrastructure

update an existing cloud-region

application/json application/xml

cloud-region object that needs to be updated.

cloud-owner

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

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns availability-zone

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

Tags: CloudInfrastructure

returns availability-zone

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
availability-zone-name

Name of the availability zone. Unique across a cloud region

path string

application/json application/xml

200 OK

successful operation

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.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
availability-zone-name

Name of the availability zone. Unique across a cloud region

path string

application/json application/xml

default

Response codes found in response codes.

update an existing availability-zone

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

Tags: CloudInfrastructure

update an existing availability-zone

application/json application/xml

availability-zone object that needs to be updated.

cloud-owner

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

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
availability-zone-name

Name of the availability zone. Unique across a cloud region

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship

Tags: CloudInfrastructure

delete an existing relationship

application/json application/xml

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
availability-zone-name

Name of the availability zone. Unique across a cloud region

path string

application/json application/xml

default

Response codes found in response codes.

returns dvs-switches

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

Tags: CloudInfrastructure

returns dvs-switches

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
switch-name query string
vcenter-url query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns dvs-switch

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

Tags: CloudInfrastructure

returns dvs-switch

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
switch-name

DVS switch name

path string

application/json application/xml

200 OK

successful operation

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.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
switch-name

DVS switch name

path string

application/json application/xml

default

Response codes found in response codes.

update an existing dvs-switch

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

Tags: CloudInfrastructure

update an existing dvs-switch

application/json application/xml

dvs-switch object that needs to be updated.

cloud-owner

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

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
switch-name

DVS switch name

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship

Tags: CloudInfrastructure

delete an existing relationship

application/json application/xml

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
switch-name

DVS switch name

path string

application/json application/xml

default

Response codes found in response codes.

returns esr-system-info-list

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

Tags: CloudInfrastructure

returns esr-system-info-list

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
esr-system-info-id query string
system-name query string
system-type query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns esr-system-info

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

Tags: CloudInfrastructure

returns esr-system-info

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
esr-system-info-id

Unique ID of esr system info.

path string

application/json application/xml

200 OK

successful operation

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.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
esr-system-info-id

Unique ID of esr system info.

path string

application/json application/xml

default

Response codes found in response codes.

update an existing esr-system-info

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

Tags: CloudInfrastructure

update an existing esr-system-info

application/json application/xml

esr-system-info object that needs to be updated.

cloud-owner

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

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
esr-system-info-id

Unique ID of esr system info.

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

Tags: CloudInfrastructure

delete an existing relationship

application/json application/xml

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
esr-system-info-id

Unique ID of esr system info.

path string

application/json application/xml

default

Response codes found in response codes.

returns flavors

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

Tags: CloudInfrastructure

returns flavors

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
flavor-id query string
flavor-name query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns flavor

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

Tags: CloudInfrastructure

returns flavor

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
flavor-id

Flavor id, expected to be unique across cloud-region.

path string

application/json application/xml

200 OK

successful operation

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.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
flavor-id

Flavor id, expected to be unique across cloud-region.

path string

application/json application/xml

default

Response codes found in response codes.

update an existing flavor

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

Tags: CloudInfrastructure

update an existing flavor

application/json application/xml

flavor object that needs to be updated.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
flavor-id

Flavor id, expected to be unique across cloud-region.

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing flavor

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

Tags: CloudInfrastructure

delete an existing flavor

application/json application/xml

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
flavor-id

Flavor id, expected to be unique across cloud-region.

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

returns hpa-capabilities

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

Tags: CloudInfrastructure

returns hpa-capabilities

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
flavor-id

Flavor id, expected to be unique across cloud-region.

path string
hpa-capability-id query string
hpa-feature query string
architecture query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns hpa-capability

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

Tags: CloudInfrastructure

returns hpa-capability

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
flavor-id

Flavor id, expected to be unique across cloud-region.

path string
hpa-capability-id

UUID to uniquely identify a HPA capability

path string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

create or update an existing hpa-capability

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

Tags: CloudInfrastructure

create or update an existing hpa-capability

application/json application/xml

hpa-capability object that needs to be created or updated.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
flavor-id

Flavor id, expected to be unique across cloud-region.

path string
hpa-capability-id

UUID to uniquely identify a HPA capability

path string

application/json application/xml

default

Response codes found in response codes.

update an existing hpa-capability

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

Tags: CloudInfrastructure

update an existing hpa-capability

application/json application/xml

hpa-capability object that needs to be updated.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
flavor-id

Flavor id, expected to be unique across cloud-region.

path string
hpa-capability-id

UUID to uniquely identify a HPA capability

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing hpa-capability

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

Tags: CloudInfrastructure

delete an existing hpa-capability

application/json application/xml

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
flavor-id

Flavor id, expected to be unique across cloud-region.

path string
hpa-capability-id

UUID to uniquely identify a HPA capability

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

returns hpa-feature-attributes

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

Tags: CloudInfrastructure

returns hpa-feature-attributes

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
flavor-id

Flavor id, expected to be unique across cloud-region.

path string
hpa-capability-id

UUID to uniquely identify a HPA capability

path string
hpa-attribute-key

name of the specific HPA attribute

path string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

create or update an existing hpa-feature-attributes

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

Tags: CloudInfrastructure

create or update an existing hpa-feature-attributes

application/json application/xml

hpa-feature-attributes object that needs to be created or updated.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
flavor-id

Flavor id, expected to be unique across cloud-region.

path string
hpa-capability-id

UUID to uniquely identify a HPA capability

path string
hpa-attribute-key

name of the specific HPA attribute

path string

application/json application/xml

default

Response codes found in response codes.

update an existing hpa-feature-attributes

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

Tags: CloudInfrastructure

update an existing hpa-feature-attributes

application/json application/xml

hpa-feature-attributes object that needs to be updated.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
flavor-id

Flavor id, expected to be unique across cloud-region.

path string
hpa-capability-id

UUID to uniquely identify a HPA capability

path string
hpa-attribute-key

name of the specific HPA attribute

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing hpa-feature-attributes

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

Tags: CloudInfrastructure

delete an existing hpa-feature-attributes

application/json application/xml

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
flavor-id

Flavor id, expected to be unique across cloud-region.

path string
hpa-capability-id

UUID to uniquely identify a HPA capability

path string
hpa-attribute-key

name of the specific HPA attribute

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
flavor-id

Flavor id, expected to be unique across cloud-region.

path string
hpa-capability-id

UUID to uniquely identify a HPA capability

path string
hpa-attribute-key

name of the specific HPA attribute

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

delete an existing relationship

application/json application/xml

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
flavor-id

Flavor id, expected to be unique across cloud-region.

path string
hpa-capability-id

UUID to uniquely identify a HPA capability

path string
hpa-attribute-key

name of the specific HPA attribute

path string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
flavor-id

Flavor id, expected to be unique across cloud-region.

path string
hpa-capability-id

UUID to uniquely identify a HPA capability

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship

Tags: CloudInfrastructure

delete an existing relationship

application/json application/xml

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
flavor-id

Flavor id, expected to be unique across cloud-region.

path string
hpa-capability-id

UUID to uniquely identify a HPA capability

path string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
flavor-id

Flavor id, expected to be unique across cloud-region.

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship

Tags: CloudInfrastructure

delete an existing relationship

application/json application/xml

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
flavor-id

Flavor id, expected to be unique across cloud-region.

path string

application/json application/xml

default

Response codes found in response codes.

returns group-assignments

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

Tags: CloudInfrastructure

returns group-assignments

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
group-id query string
group-type query string
group-name query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns group-assignment

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

Tags: CloudInfrastructure

returns group-assignment

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
group-id

Group id, expected to be unique across cloud-region.

path string

application/json application/xml

200 OK

successful operation

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.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
group-id

Group id, expected to be unique across cloud-region.

path string

application/json application/xml

default

Response codes found in response codes.

update an existing group-assignment

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

Tags: CloudInfrastructure

update an existing group-assignment

application/json application/xml

group-assignment object that needs to be updated.

cloud-owner

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

cloud-owner

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

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

Tags: CloudInfrastructure

returns hpa-capabilities

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
hpa-capability-id query string
hpa-feature query string
architecture query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns hpa-capability

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

Tags: CloudInfrastructure

returns hpa-capability

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
hpa-capability-id

UUID to uniquely identify a HPA capability

path string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

create or update an existing hpa-capability

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

Tags: CloudInfrastructure

create or update an existing hpa-capability

application/json application/xml

hpa-capability object that needs to be created or updated.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
hpa-capability-id

UUID to uniquely identify a HPA capability

path string

application/json application/xml

default

Response codes found in response codes.

update an existing hpa-capability

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

Tags: CloudInfrastructure

update an existing hpa-capability

application/json application/xml

hpa-capability object that needs to be updated.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
hpa-capability-id

UUID to uniquely identify a HPA capability

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing hpa-capability

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

Tags: CloudInfrastructure

delete an existing hpa-capability

application/json application/xml

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
hpa-capability-id

UUID to uniquely identify a HPA capability

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

returns hpa-feature-attributes

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

Tags: CloudInfrastructure

returns hpa-feature-attributes

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
hpa-capability-id

UUID to uniquely identify a HPA capability

path string
hpa-attribute-key

name of the specific HPA attribute

path string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

create or update an existing hpa-feature-attributes

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

Tags: CloudInfrastructure

create or update an existing hpa-feature-attributes

application/json application/xml

hpa-feature-attributes object that needs to be created or updated.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
hpa-capability-id

UUID to uniquely identify a HPA capability

path string
hpa-attribute-key

name of the specific HPA attribute

path string

application/json application/xml

default

Response codes found in response codes.

update an existing hpa-feature-attributes

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

Tags: CloudInfrastructure

update an existing hpa-feature-attributes

application/json application/xml

hpa-feature-attributes object that needs to be updated.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
hpa-capability-id

UUID to uniquely identify a HPA capability

path string
hpa-attribute-key

name of the specific HPA attribute

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing hpa-feature-attributes

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

Tags: CloudInfrastructure

delete an existing hpa-feature-attributes

application/json application/xml

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
hpa-capability-id

UUID to uniquely identify a HPA capability

path string
hpa-attribute-key

name of the specific HPA attribute

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
hpa-capability-id

UUID to uniquely identify a HPA capability

path string
hpa-attribute-key

name of the specific HPA attribute

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}/relationship-list/relationship

Tags: CloudInfrastructure

delete an existing relationship

application/json application/xml

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
hpa-capability-id

UUID to uniquely identify a HPA capability

path string
hpa-attribute-key

name of the specific HPA attribute

path string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
hpa-capability-id

UUID to uniquely identify a HPA capability

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship

Tags: CloudInfrastructure

delete an existing relationship

application/json application/xml

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
hpa-capability-id

UUID to uniquely identify a HPA capability

path string

application/json application/xml

default

Response codes found in response codes.

returns images

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

Tags: CloudInfrastructure

returns images

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
image-id query string
image-name query string
application query string
application-vendor query string
application-version query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns image

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

Tags: CloudInfrastructure

returns image

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
image-id

Image id, expected to be unique across cloud region

path string

application/json application/xml

200 OK

successful operation

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.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
image-id

Image id, expected to be unique across cloud region

path string

application/json application/xml

default

Response codes found in response codes.

update an existing image

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

Tags: CloudInfrastructure

update an existing image

application/json application/xml

image object that needs to be updated.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
image-id

Image id, expected to be unique across cloud region

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing image

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

Tags: CloudInfrastructure

delete an existing image

application/json application/xml

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
image-id

Image id, expected to be unique across cloud region

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

returns metadata

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

Tags: CloudInfrastructure

returns metadata

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
image-id

Image id, expected to be unique across cloud region

path string
metaname query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns metadatum

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

Tags: CloudInfrastructure

returns metadatum

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
image-id

Image id, expected to be unique across cloud region

path string
metaname path string

application/json application/xml

200 OK

successful operation

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.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
image-id

Image id, expected to be unique across cloud region

path string
metaname path string

application/json application/xml

default

Response codes found in response codes.

update an existing metadatum

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

Tags: CloudInfrastructure

update an existing metadatum

application/json application/xml

metadatum object that needs to be updated.

cloud-owner

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

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
image-id

Image id, expected to be unique across cloud region

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship

Tags: CloudInfrastructure

delete an existing relationship

application/json application/xml

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
image-id

Image id, expected to be unique across cloud region

path string

application/json application/xml

default

Response codes found in response codes.

returns oam-networks

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

Tags: CloudInfrastructure

returns oam-networks

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
network-uuid query string
network-name query string
cvlan-tag query integer

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns oam-network

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

Tags: CloudInfrastructure

returns oam-network

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
network-uuid

UUID of the network. Unique across a cloud-region

path string

application/json application/xml

200 OK

successful operation

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.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
network-uuid

UUID of the network. Unique across a cloud-region

path string

application/json application/xml

default

Response codes found in response codes.

update an existing oam-network

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

Tags: CloudInfrastructure

update an existing oam-network

application/json application/xml

oam-network object that needs to be updated.

cloud-owner

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

cloud-owner

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

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship

Tags: CloudInfrastructure

delete an existing relationship

application/json application/xml

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string

application/json application/xml

default

Response codes found in response codes.

returns snapshots

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

Tags: CloudInfrastructure

returns snapshots

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
snapshot-id query string
snapshot-name query string
application query string
application-vendor query string
application-version query string
prev-snapshot-id query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns snapshot

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

Tags: CloudInfrastructure

returns snapshot

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
snapshot-id

Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

path string

application/json application/xml

200 OK

successful operation

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.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
snapshot-id

Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

path string

application/json application/xml

default

Response codes found in response codes.

update an existing snapshot

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

Tags: CloudInfrastructure

update an existing snapshot

application/json application/xml

snapshot object that needs to be updated.

cloud-owner

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

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
snapshot-id

Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship

Tags: CloudInfrastructure

delete an existing relationship

application/json application/xml

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
snapshot-id

Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

path string

application/json application/xml

default

Response codes found in response codes.

returns tenants

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

Tags: CloudInfrastructure

returns tenants

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id query string
tenant-name query string
tenant-context query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns tenant

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

Tags: CloudInfrastructure

returns tenant

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string

application/json application/xml

200 OK

successful operation

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.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string

application/json application/xml

default

Response codes found in response codes.

update an existing tenant

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

Tags: CloudInfrastructure

update an existing tenant

application/json application/xml

tenant object that needs to be updated.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing tenant

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

Tags: CloudInfrastructure

delete an existing tenant

application/json application/xml

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

returns nos-servers

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

Tags: CloudInfrastructure

returns nos-servers

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
nos-server-id query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns nos-server

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

Tags: CloudInfrastructure

returns nos-server

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
nos-server-id

Unique identifier for this nos relative to its tenant

path string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

create or update an existing nos-server

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

Tags: CloudInfrastructure

create or update an existing nos-server

application/json application/xml

nos-server object that needs to be created or updated.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
nos-server-id

Unique identifier for this nos relative to its tenant

path string

application/json application/xml

default

Response codes found in response codes.

update an existing nos-server

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

Tags: CloudInfrastructure

update an existing nos-server

application/json application/xml

nos-server object that needs to be updated.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
nos-server-id

Unique identifier for this nos relative to its tenant

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing nos-server

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

Tags: CloudInfrastructure

delete an existing nos-server

application/json application/xml

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
nos-server-id

Unique identifier for this nos relative to its tenant

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
nos-server-id

Unique identifier for this nos relative to its tenant

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/nos-servers/nos-server/{nos-server-id}/relationship-list/relationship

Tags: CloudInfrastructure

delete an existing relationship

application/json application/xml

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
nos-server-id

Unique identifier for this nos relative to its tenant

path string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship

Tags: CloudInfrastructure

delete an existing relationship

application/json application/xml

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string

application/json application/xml

default

Response codes found in response codes.

returns vservers

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

Tags: CloudInfrastructure

returns vservers

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id query string
vserver-name query string
vserver-name2 query string
prov-status query string
in-maint query boolean
is-closed-loop-disabled query boolean

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns vserver

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

Tags: CloudInfrastructure

returns vserver

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id

Unique identifier for this vserver relative to its tenant

path string

application/json application/xml

200 OK

successful operation

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.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id

Unique identifier for this vserver relative to its tenant

path string

application/json application/xml

default

Response codes found in response codes.

update an existing vserver

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

Tags: CloudInfrastructure

update an existing vserver

application/json application/xml

vserver object that needs to be updated.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id

Unique identifier for this vserver relative to its tenant

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing vserver

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

Tags: CloudInfrastructure

delete an existing vserver

application/json application/xml

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id

Unique identifier for this vserver relative to its tenant

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

returns l-interfaces

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

Tags: CloudInfrastructure

returns l-interfaces

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id

Unique identifier for this vserver relative to its tenant

path string
interface-name query string
interface-id query string
macaddr query string
network-name query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns l-interface

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

Tags: CloudInfrastructure

returns l-interface

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id

Unique identifier for this vserver relative to its tenant

path string
interface-name

Name given to the interface

path string

application/json application/xml

200 OK

successful operation

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.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id

Unique identifier for this vserver relative to its tenant

path string
interface-name

Name given to the interface

path string

application/json application/xml

default

Response codes found in response codes.

update an existing l-interface

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

Tags: CloudInfrastructure

update an existing l-interface

application/json application/xml

l-interface object that needs to be updated.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id

Unique identifier for this vserver relative to its tenant

path string
interface-name

Name given to the interface

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing l-interface

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

Tags: CloudInfrastructure

delete an existing l-interface

application/json application/xml

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id

Unique identifier for this vserver relative to its tenant

path string
interface-name

Name given to the interface

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

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

Tags: CloudInfrastructure

returns l3-interface-ipv4-address-list

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id

Unique identifier for this vserver relative to its tenant

path string
interface-name

Name given to the interface

path string
l3-interface-ipv4-address

IP address

path string

application/json application/xml

200 OK

successful operation

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.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id

Unique identifier for this vserver relative to its tenant

path string
interface-name

Name given to the interface

path string
l3-interface-ipv4-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

update an existing l3-interface-ipv4-address-list

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

Tags: CloudInfrastructure

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

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

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id

Unique identifier for this vserver relative to its tenant

path string
interface-name

Name given to the interface

path string
l3-interface-ipv4-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

delete an existing relationship

application/json application/xml

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id

Unique identifier for this vserver relative to its tenant

path string
interface-name

Name given to the interface

path string
l3-interface-ipv4-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

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

Tags: CloudInfrastructure

returns l3-interface-ipv6-address-list

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id

Unique identifier for this vserver relative to its tenant

path string
interface-name

Name given to the interface

path string
l3-interface-ipv6-address

IP address

path string

application/json application/xml

200 OK

successful operation

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.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id

Unique identifier for this vserver relative to its tenant

path string
interface-name

Name given to the interface

path string
l3-interface-ipv6-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

update an existing l3-interface-ipv6-address-list

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

Tags: CloudInfrastructure

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

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

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

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

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id

Unique identifier for this vserver relative to its tenant

path string
interface-name

Name given to the interface

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

delete an existing relationship

application/json application/xml

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id

Unique identifier for this vserver relative to its tenant

path string
interface-name

Name given to the interface

path string

application/json application/xml

default

Response codes found in response codes.

returns sriov-vfs

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

Tags: CloudInfrastructure

returns sriov-vfs

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id

Unique identifier for this vserver relative to its tenant

path string
interface-name

Name given to the interface

path string
pci-id query string
vf-vlan-filter query string
vf-mac-filter query string
vf-vlan-strip query boolean
neutron-network-id query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns sriov-vf

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

Tags: CloudInfrastructure

returns sriov-vf

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id

Unique identifier for this vserver relative to its tenant

path string
interface-name

Name given to the interface

path string
pci-id

PCI ID used to identify the sriov-vf

path string

application/json application/xml

200 OK

successful operation

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.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id

Unique identifier for this vserver relative to its tenant

path string
interface-name

Name given to the interface

path string
pci-id

PCI ID used to identify the sriov-vf

path string

application/json application/xml

default

Response codes found in response codes.

update an existing sriov-vf

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

Tags: CloudInfrastructure

update an existing sriov-vf

application/json application/xml

sriov-vf object that needs to be updated.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

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

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
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
vlan-interface query string
vlan-id-inner query integer
vpn-key query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns vlan

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

Tags: CloudInfrastructure

returns vlan

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id

Unique identifier for this vserver relative to its tenant

path string
interface-name

Name given to the interface

path string
vlan-interface

String that identifies the interface

path string

application/json application/xml

200 OK

successful operation

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.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id

Unique identifier for this vserver relative to its tenant

path string
interface-name

Name given to the interface

path string
vlan-interface

String that identifies the interface

path string

application/json application/xml

default

Response codes found in response codes.

update an existing vlan

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

Tags: CloudInfrastructure

update an existing vlan

application/json application/xml

vlan object that needs to be updated.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id

Unique identifier for this vserver relative to its tenant

path string
interface-name

Name given to the interface

path string
vlan-interface

String that identifies the interface

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing vlan

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

Tags: CloudInfrastructure

delete an existing vlan

application/json application/xml

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id

Unique identifier for this vserver relative to its tenant

path string
interface-name

Name given to the interface

path string
vlan-interface

String that identifies the interface

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

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

Tags: CloudInfrastructure

returns l3-interface-ipv4-address-list

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id

Unique identifier for this vserver relative to its tenant

path string
interface-name

Name given to the interface

path string
vlan-interface

String that identifies the interface

path string
l3-interface-ipv4-address

IP address

path string

application/json application/xml

200 OK

successful operation

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.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id

Unique identifier for this vserver relative to its tenant

path string
interface-name

Name given to the interface

path string
vlan-interface

String that identifies the interface

path string
l3-interface-ipv4-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

update an existing l3-interface-ipv4-address-list

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

Tags: CloudInfrastructure

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

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

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id

Unique identifier for this vserver relative to its tenant

path string
interface-name

Name given to the interface

path string
vlan-interface

String that identifies the interface

path string
l3-interface-ipv4-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

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

Tags: CloudInfrastructure

delete an existing relationship

application/json application/xml

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id

Unique identifier for this vserver relative to its tenant

path string
interface-name

Name given to the interface

path string
vlan-interface

String that identifies the interface

path string
l3-interface-ipv4-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

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

Tags: CloudInfrastructure

returns l3-interface-ipv6-address-list

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id

Unique identifier for this vserver relative to its tenant

path string
interface-name

Name given to the interface

path string
vlan-interface

String that identifies the interface

path string
l3-interface-ipv6-address

IP address

path string

application/json application/xml

200 OK

successful operation

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.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id

Unique identifier for this vserver relative to its tenant

path string
interface-name

Name given to the interface

path string
vlan-interface

String that identifies the interface

path string
l3-interface-ipv6-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

update an existing l3-interface-ipv6-address-list

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

Tags: CloudInfrastructure

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

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

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

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

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

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

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id

Unique identifier for this vserver relative to its tenant

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship

Tags: CloudInfrastructure

delete an existing relationship

application/json application/xml

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id

Unique identifier for this vserver relative to its tenant

path string

application/json application/xml

default

Response codes found in response codes.

returns volumes

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

Tags: CloudInfrastructure

returns volumes

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id

Unique identifier for this vserver relative to its tenant

path string
volume-id query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns volume

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

Tags: CloudInfrastructure

returns volume

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id

Unique identifier for this vserver relative to its tenant

path string
volume-id

Unique ID of block storage volume relative to the vserver.

path string

application/json application/xml

200 OK

successful operation

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.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
tenant-id

Unique id relative to the cloud-region.

path string
vserver-id

Unique identifier for this vserver relative to its tenant

path string
volume-id

Unique ID of block storage volume relative to the vserver.

path string

application/json application/xml

default

Response codes found in response codes.

update an existing volume

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

Tags: CloudInfrastructure

update an existing volume

application/json application/xml

volume object that needs to be updated.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

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

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

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

application/json application/xml

200 OK

successful operation

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.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
vip-ipv4-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

update an existing vip-ipv4-address-list

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

Tags: CloudInfrastructure

update an existing vip-ipv4-address-list

application/json application/xml

vip-ipv4-address-list object that needs to be updated.

cloud-owner

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

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
vip-ipv4-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship

Tags: CloudInfrastructure

delete an existing relationship

application/json application/xml

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
vip-ipv4-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

returns vip-ipv6-address-list

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

Tags: CloudInfrastructure

returns vip-ipv6-address-list

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
vip-ipv6-address

IP address

path string

application/json application/xml

200 OK

successful operation

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.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
vip-ipv6-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

update an existing vip-ipv6-address-list

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

Tags: CloudInfrastructure

update an existing vip-ipv6-address-list

application/json application/xml

vip-ipv6-address-list object that needs to be updated.

cloud-owner

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

cloud-owner

Identifies the vendor and cloud name. First part of composite key should be 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
volume-group-id query string
volume-group-name query string
heat-stack-id query string
vnf-type query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns volume-group

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

Tags: CloudInfrastructure

returns volume-group

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
volume-group-id

Unique ID of volume-group.

path string

application/json application/xml

200 OK

successful operation

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.

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
volume-group-id

Unique ID of volume-group.

path string

application/json application/xml

default

Response codes found in response codes.

update an existing volume-group

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

Tags: CloudInfrastructure

update an existing volume-group

application/json application/xml

volume-group object that needs to be updated.

cloud-owner

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

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
volume-group-id

Unique ID of volume-group.

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship

Tags: CloudInfrastructure

delete an existing relationship

application/json application/xml

cloud-owner

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

path string
cloud-region-id

Identifier used by the vendor for the region. Second part of composite key

path string
volume-group-id

Unique ID of volume-group.

path string

application/json application/xml

default

Response codes found in response codes.

returns complexes

GET /cloud-infrastructure/complexes

Tags: CloudInfrastructure

returns complexes

physical-location-id query string
data-center-code query string
complex-name query string
identity-url query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns complex

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

Tags: CloudInfrastructure

returns complex

physical-location-id

Unique identifier for physical location, e.g., CLLI

path string

application/json application/xml

200 OK

successful operation

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.

physical-location-id

Unique identifier for physical location, e.g., CLLI

path string

application/json application/xml

default

Response codes found in response codes.

update an existing complex

PATCH /cloud-infrastructure/complexes/complex/{physical-location-id}

Tags: CloudInfrastructure

update an existing complex

application/json application/xml

complex object that needs to be updated.

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
availability-zone-name query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns ctag-pool

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

Tags: CloudInfrastructure

returns ctag-pool

physical-location-id

Unique identifier for physical location, e.g., CLLI

path string
target-pe

The Target provider edge router

path string
availability-zone-name

Name of the availability zone

path string

application/json application/xml

200 OK

successful operation

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.

physical-location-id

Unique identifier for physical location, e.g., CLLI

path string
target-pe

The Target provider edge router

path string
availability-zone-name

Name of the availability zone

path string

application/json application/xml

default

Response codes found in response codes.

update an existing ctag-pool

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

Tags: CloudInfrastructure

update an existing ctag-pool

application/json application/xml

ctag-pool object that needs to be updated.

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.

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.

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

nm-profile-name query string

application/json application/xml

200 OK

successful operation

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

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.

nm-profile-name

Unique name of network profile.

path string

application/json application/xml

default

Response codes found in response codes.

update an existing network-profile

PATCH /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

Tags: CloudInfrastructure

update an existing network-profile

application/json application/xml

network-profile object that needs to be updated.

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.

nm-profile-name

Unique name of network profile.

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship

Tags: CloudInfrastructure

delete an existing relationship

application/json application/xml

nm-profile-name

Unique name of network profile.

path string

application/json application/xml

default

Response codes found in response codes.

returns network-technologies

GET /cloud-infrastructure/network-technologies

Tags: CloudInfrastructure

returns network-technologies

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns network-technology

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

Tags: CloudInfrastructure

returns network-technology

network-technology-id

Unique identifier of the network-technology object (UUID)

path string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

create or update an existing network-technology

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

Tags: CloudInfrastructure

create or update an existing network-technology

application/json application/xml

network-technology object that needs to be created or updated.

network-technology-id

Unique identifier of the network-technology object (UUID)

path string

application/json application/xml

default

Response codes found in response codes.

update an existing network-technology

PATCH /cloud-infrastructure/network-technologies/network-technology/{network-technology-id}

Tags: CloudInfrastructure

update an existing network-technology

application/json application/xml

network-technology object that needs to be updated.

network-technology-id

Unique identifier of the network-technology object (UUID)

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing network-technology

DELETE /cloud-infrastructure/network-technologies/network-technology/{network-technology-id}

Tags: CloudInfrastructure

delete an existing network-technology

application/json application/xml

network-technology-id

Unique identifier of the network-technology object (UUID)

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

network-technology-id

Unique identifier of the network-technology object (UUID)

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/network-technologies/network-technology/{network-technology-id}/relationship-list/relationship

Tags: CloudInfrastructure

delete an existing relationship

application/json application/xml

network-technology-id

Unique identifier of the network-technology object (UUID)

path string

application/json application/xml

default

Response codes found in response codes.

returns operational-environments

GET /cloud-infrastructure/operational-environments

Tags: CloudInfrastructure

returns operational-environments

operational-environment-id query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns operational-environment

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

Tags: CloudInfrastructure

returns operational-environment

operational-environment-id

UUID of an operational environment

path string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

create or update an existing operational-environment

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

Tags: CloudInfrastructure

create or update an existing operational-environment

application/json application/xml

operational-environment object that needs to be created or updated.

operational-environment-id

UUID of an operational environment

path string

application/json application/xml

default

Response codes found in response codes.

update an existing operational-environment

PATCH /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}

Tags: CloudInfrastructure

update an existing operational-environment

application/json application/xml

operational-environment object that needs to be updated.

operational-environment-id

UUID of an operational environment

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing operational-environment

DELETE /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}

Tags: CloudInfrastructure

delete an existing operational-environment

application/json application/xml

operational-environment-id

UUID of an operational environment

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

operational-environment-id

UUID of an operational environment

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}/relationship-list/relationship

Tags: CloudInfrastructure

delete an existing relationship

application/json application/xml

operational-environment-id

UUID of an operational environment

path string

application/json application/xml

default

Response codes found in response codes.

returns pservers

GET /cloud-infrastructure/pservers

Tags: CloudInfrastructure

returns pservers

hostname query string
inv-status query string
pserver-id query string
in-maint query boolean
pserver-name2 query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns pserver

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

Tags: CloudInfrastructure

returns pserver

hostname

Value from executing hostname on the compute node.

path string

application/json application/xml

200 OK

successful operation

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.

hostname

Value from executing hostname on the compute node.

path string

application/json application/xml

default

Response codes found in response codes.

update an existing pserver

PATCH /cloud-infrastructure/pservers/pserver/{hostname}

Tags: CloudInfrastructure

update an existing pserver

application/json application/xml

pserver object that needs to be updated.

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

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

Tags: CloudInfrastructure

returns hpa-capacity

hostname

Value from executing hostname on the compute node.

path string
hpa-capacity-key

Composite key formed with hpaFeature and append list of hpaFeatureAttributes needed for capacity check

path string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

create or update an existing hpa-capacity

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

Tags: CloudInfrastructure

create or update an existing hpa-capacity

application/json application/xml

hpa-capacity object that needs to be created or updated.

hostname

Value from executing hostname on the compute node.

path string
hpa-capacity-key

Composite key formed with hpaFeature and append list of hpaFeatureAttributes needed for capacity check

path string

application/json application/xml

default

Response codes found in response codes.

update an existing hpa-capacity

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

Tags: CloudInfrastructure

update an existing hpa-capacity

application/json application/xml

hpa-capacity object that needs to be updated.

hostname

Value from executing hostname on the compute node.

path string
hpa-capacity-key

Composite key formed with hpaFeature and append list of hpaFeatureAttributes needed for capacity check

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing hpa-capacity

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

Tags: CloudInfrastructure

delete an existing hpa-capacity

application/json application/xml

hostname

Value from executing hostname on the compute node.

path string
hpa-capacity-key

Composite key formed with hpaFeature and append list of hpaFeatureAttributes needed for capacity check

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

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

Tags: CloudInfrastructure

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

hostname

Value from executing hostname on the compute node.

path string
hpa-capacity-key

Composite key formed with hpaFeature and append list of hpaFeatureAttributes needed for capacity check

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/hpa-capacity/{hpa-capacity-key}/relationship-list/relationship

Tags: CloudInfrastructure

delete an existing relationship

application/json application/xml

hostname

Value from executing hostname on the compute node.

path string
hpa-capacity-key

Composite key formed with hpaFeature and append list of hpaFeatureAttributes needed for capacity check

path string

application/json application/xml

default

Response codes found in response codes.

returns lag-interfaces

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

Tags: CloudInfrastructure

returns lag-interfaces

hostname

Value from executing hostname on the compute node.

path string
interface-name query string
interface-id query string
interface-role query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns lag-interface

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

Tags: CloudInfrastructure

returns lag-interface

hostname

Value from executing hostname on the compute node.

path string
interface-name

Name that identifies the link aggregate interface

path string

application/json application/xml

200 OK

successful operation

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.

hostname

Value from executing hostname on the compute node.

path string
interface-name

Name that identifies the link aggregate interface

path string

application/json application/xml

default

Response codes found in response codes.

update an existing lag-interface

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

Tags: CloudInfrastructure

update an existing lag-interface

application/json application/xml

lag-interface object that needs to be updated.

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
interface-name query string
interface-id query string
macaddr query string
network-name query string

application/json application/xml

200 OK

successful operation

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing l-interface

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

Tags: CloudInfrastructure

update an existing l-interface

application/json application/xml

l-interface object that needs to be updated.

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing l3-interface-ipv4-address-list

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

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

hostname

Value from executing hostname on the compute node.

path string
interface-name

Name that identifies the link aggregate interface

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

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing l3-interface-ipv6-address-list

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

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

hostname

Value from executing hostname on the compute node.

path string
interface-name

Name that identifies the link aggregate interface

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

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.

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
pci-id query string
vf-vlan-filter query string
vf-mac-filter query string
vf-vlan-strip query boolean
neutron-network-id query string

application/json application/xml

200 OK

successful operation

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing sriov-vf

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

update an existing sriov-vf

application/json application/xml

sriov-vf object that needs to be updated.

hostname

Value from executing hostname on the compute node.

path string
interface-name

Name that identifies the link aggregate interface

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

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
vlan-interface query string
vlan-id-inner query integer
vpn-key query string

application/json application/xml

200 OK

successful operation

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing vlan

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

Tags: CloudInfrastructure

update an existing vlan

application/json application/xml

vlan object that needs to be updated.

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing l3-interface-ipv4-address-list

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

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

hostname

Value from executing hostname on the compute node.

path string
interface-name

Name that identifies the link aggregate interface

path string
interface-name

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.

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing l3-interface-ipv6-address-list

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

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

hostname

Value from executing hostname on the compute node.

path string
interface-name

Name that identifies the link aggregate interface

path string
interface-name

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.

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.

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.

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
interface-name query string
prov-status query string
operational-status query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns p-interface

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

Tags: CloudInfrastructure

returns p-interface

hostname

Value from executing hostname on the compute node.

path string
interface-name

Name that identifies the physical interface

path string

application/json application/xml

200 OK

successful operation

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.

hostname

Value from executing hostname on the compute node.

path string
interface-name

Name that identifies the physical interface

path string

application/json application/xml

default

Response codes found in response codes.

update an existing p-interface

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

Tags: CloudInfrastructure

update an existing p-interface

application/json application/xml

p-interface object that needs to be updated.

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
interface-name query string
interface-id query string
macaddr query string
network-name query string

application/json application/xml

200 OK

successful operation

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing l-interface

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

Tags: CloudInfrastructure

update an existing l-interface

application/json application/xml

l-interface object that needs to be updated.

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing l3-interface-ipv4-address-list

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

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

hostname

Value from executing hostname on the compute node.

path string
interface-name

Name that identifies the physical interface

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

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing l3-interface-ipv6-address-list

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

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

hostname

Value from executing hostname on the compute node.

path string
interface-name

Name that identifies the physical interface

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

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.

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
pci-id query string
vf-vlan-filter query string
vf-mac-filter query string
vf-vlan-strip query boolean
neutron-network-id query string

application/json application/xml

200 OK

successful operation

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing sriov-vf

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

update an existing sriov-vf

application/json application/xml

sriov-vf object that needs to be updated.

hostname

Value from executing hostname on the compute node.

path string
interface-name

Name that identifies the physical interface

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

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
vlan-interface query string
vlan-id-inner query integer
vpn-key query string

application/json application/xml

200 OK

successful operation

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing vlan

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

Tags: CloudInfrastructure

update an existing vlan

application/json application/xml

vlan object that needs to be updated.

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing l3-interface-ipv4-address-list

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

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

hostname

Value from executing hostname on the compute node.

path string
interface-name

Name that identifies the physical interface

path string
interface-name

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.

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing l3-interface-ipv6-address-list

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

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

hostname

Value from executing hostname on the compute node.

path string
interface-name

Name that identifies the physical interface

path string
interface-name

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.

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.

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.

hostname

Value from executing hostname on the compute node.

path string
interface-name

Name that identifies the physical interface

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

Tags: CloudInfrastructure

delete an existing relationship

application/json application/xml

hostname

Value from executing hostname on the compute node.

path string
interface-name

Name that identifies the physical interface

path string

application/json application/xml

default

Response codes found in response codes.

returns sriov-pfs

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

Tags: CloudInfrastructure

returns sriov-pfs

hostname

Value from executing hostname on the compute node.

path string
interface-name

Name that identifies the physical interface

path string
pf-pci-id query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns sriov-pf

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

Tags: CloudInfrastructure

returns sriov-pf

hostname

Value from executing hostname on the compute node.

path string
interface-name

Name that identifies the physical interface

path string
pf-pci-id

Identifier for the sriov-pf

path string

application/json application/xml

200 OK

successful operation

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.

hostname

Value from executing hostname on the compute node.

path string
interface-name

Name that identifies the physical interface

path string
pf-pci-id

Identifier for the sriov-pf

path string

application/json application/xml

default

Response codes found in response codes.

update an existing sriov-pf

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

Tags: CloudInfrastructure

update an existing sriov-pf

application/json application/xml

sriov-pf object that needs to be updated.

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.

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.

hostname

Value from executing hostname on the compute node.

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship

Tags: CloudInfrastructure

delete an existing relationship

application/json application/xml

hostname

Value from executing hostname on the compute node.

path string

application/json application/xml

default

Response codes found in response codes.

returns virtual-data-centers

GET /cloud-infrastructure/virtual-data-centers

Tags: CloudInfrastructure

returns virtual-data-centers

vdc-id query string
vdc-name query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns virtual-data-center

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

Tags: CloudInfrastructure

returns virtual-data-center

vdc-id

Unique ID of the vdc

path string

application/json application/xml

200 OK

successful operation

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.

vdc-id

Unique ID of the vdc

path string

application/json application/xml

default

Response codes found in response codes.

update an existing virtual-data-center

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

Tags: CloudInfrastructure

update an existing virtual-data-center

application/json application/xml

virtual-data-center object that needs to be updated.

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.

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 collections

GET /network/collections

Tags: Network

returns collections

collection-id query string
model-invariant-id query string
model-version-id query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns collection

GET /network/collections/collection/{collection-id}

Tags: Network

returns collection

collection-id

Collection Object UUID

path string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

create or update an existing collection

PUT /network/collections/collection/{collection-id}

Tags: Network

create or update an existing collection

application/json application/xml

collection object that needs to be created or updated.

collection-id

Collection Object UUID

path string

application/json application/xml

default

Response codes found in response codes.

update an existing collection

PATCH /network/collections/collection/{collection-id}

Tags: Network

update an existing collection

application/json application/xml

collection object that needs to be updated.

collection-id

Collection Object UUID

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing collection

DELETE /network/collections/collection/{collection-id}

Tags: Network

delete an existing collection

application/json application/xml

collection-id

Collection Object UUID

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/collections/collection/{collection-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

collection-id

Collection Object UUID

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/collections/collection/{collection-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

collection-id

Collection Object UUID

path string

application/json application/xml

default

Response codes found in response codes.

returns configurations

GET /network/configurations

Tags: Network

returns configurations

configuration-id query string
model-invariant-id query string
model-version-id query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns configuration

GET /network/configurations/configuration/{configuration-id}

Tags: Network

returns configuration

configuration-id

UUID assigned to configuration.

path string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

create or update an existing configuration

PUT /network/configurations/configuration/{configuration-id}

Tags: Network

create or update an existing configuration

application/json application/xml

configuration object that needs to be created or updated.

configuration-id

UUID assigned to configuration.

path string

application/json application/xml

default

Response codes found in response codes.

update an existing configuration

PATCH /network/configurations/configuration/{configuration-id}

Tags: Network

update an existing configuration

application/json application/xml

configuration object that needs to be updated.

configuration-id

UUID assigned to configuration.

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing configuration

DELETE /network/configurations/configuration/{configuration-id}

Tags: Network

delete an existing configuration

application/json application/xml

configuration-id

UUID assigned to configuration.

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

returns evcs

GET /network/configurations/configuration/{configuration-id}/evcs

Tags: Network

returns evcs

configuration-id

UUID assigned to configuration.

path string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns evc

GET /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}

Tags: Network

returns evc

configuration-id

UUID assigned to configuration.

path string
evc-id

Unique/key field for the evc object

path string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

create or update an existing evc

PUT /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}

Tags: Network

create or update an existing evc

application/json application/xml

evc object that needs to be created or updated.

configuration-id

UUID assigned to configuration.

path string
evc-id

Unique/key field for the evc object

path string

application/json application/xml

default

Response codes found in response codes.

update an existing evc

PATCH /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}

Tags: Network

update an existing evc

application/json application/xml

evc object that needs to be updated.

configuration-id

UUID assigned to configuration.

path string
evc-id

Unique/key field for the evc object

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing evc

DELETE /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}

Tags: Network

delete an existing evc

application/json application/xml

configuration-id

UUID assigned to configuration.

path string
evc-id

Unique/key field for the evc object

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

configuration-id

UUID assigned to configuration.

path string
evc-id

Unique/key field for the evc object

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

configuration-id

UUID assigned to configuration.

path string
evc-id

Unique/key field for the evc object

path string

application/json application/xml

default

Response codes found in response codes.

returns forwarder-evcs

GET /network/configurations/configuration/{configuration-id}/forwarder-evcs

Tags: Network

returns forwarder-evcs

configuration-id

UUID assigned to configuration.

path string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns forwarder-evc

GET /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}

Tags: Network

returns forwarder-evc

configuration-id

UUID assigned to configuration.

path string
forwarder-evc-id

Key for forwarder-evc object

path string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

create or update an existing forwarder-evc

PUT /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}

Tags: Network

create or update an existing forwarder-evc

application/json application/xml

forwarder-evc object that needs to be created or updated.

configuration-id

UUID assigned to configuration.

path string
forwarder-evc-id

Key for forwarder-evc object

path string

application/json application/xml

default

Response codes found in response codes.

update an existing forwarder-evc

PATCH /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}

Tags: Network

update an existing forwarder-evc

application/json application/xml

forwarder-evc object that needs to be updated.

configuration-id

UUID assigned to configuration.

path string
forwarder-evc-id

Key for forwarder-evc object

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing forwarder-evc

DELETE /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}

Tags: Network

delete an existing forwarder-evc

application/json application/xml

configuration-id

UUID assigned to configuration.

path string
forwarder-evc-id

Key for forwarder-evc object

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

configuration-id

UUID assigned to configuration.

path string
forwarder-evc-id

Key for forwarder-evc object

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

configuration-id

UUID assigned to configuration.

path string
forwarder-evc-id

Key for forwarder-evc object

path string

application/json application/xml

default

Response codes found in response codes.

returns vlan-mappings

GET /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/vlan-mappings

Tags: Network

returns vlan-mappings

configuration-id

UUID assigned to configuration.

path string
forwarder-evc-id

Key for forwarder-evc object

path string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns vlan-mapping

GET /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/vlan-mappings/vlan-mapping/{vlan-mapping-id}

Tags: Network

returns vlan-mapping

configuration-id

UUID assigned to configuration.

path string
forwarder-evc-id

Key for forwarder-evc object

path string
vlan-mapping-id

Key for vlan-mapping object.

path string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

create or update an existing vlan-mapping

PUT /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/vlan-mappings/vlan-mapping/{vlan-mapping-id}

Tags: Network

create or update an existing vlan-mapping

application/json application/xml

vlan-mapping object that needs to be created or updated.

configuration-id

UUID assigned to configuration.

path string
forwarder-evc-id

Key for forwarder-evc object

path string
vlan-mapping-id

Key for vlan-mapping object.

path string

application/json application/xml

default

Response codes found in response codes.

update an existing vlan-mapping

PATCH /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/vlan-mappings/vlan-mapping/{vlan-mapping-id}

Tags: Network

update an existing vlan-mapping

application/json application/xml

vlan-mapping object that needs to be updated.

configuration-id

UUID assigned to configuration.

path string
forwarder-evc-id

Key for forwarder-evc object

path string
vlan-mapping-id

Key for vlan-mapping object.

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing vlan-mapping

DELETE /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/vlan-mappings/vlan-mapping/{vlan-mapping-id}

Tags: Network

delete an existing vlan-mapping

application/json application/xml

configuration-id

UUID assigned to configuration.

path string
forwarder-evc-id

Key for forwarder-evc object

path string
vlan-mapping-id

Key for vlan-mapping object.

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/vlan-mappings/vlan-mapping/{vlan-mapping-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

configuration-id

UUID assigned to configuration.

path string
forwarder-evc-id

Key for forwarder-evc object

path string
vlan-mapping-id

Key for vlan-mapping object.

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/vlan-mappings/vlan-mapping/{vlan-mapping-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

configuration-id

UUID assigned to configuration.

path string
forwarder-evc-id

Key for forwarder-evc object

path string
vlan-mapping-id

Key for vlan-mapping object.

path string

application/json application/xml

default

Response codes found in response codes.

returns metadata

GET /network/configurations/configuration/{configuration-id}/metadata

Tags: Network

returns metadata

configuration-id

UUID assigned to configuration.

path string
metaname query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns metadatum

GET /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}

Tags: Network

returns metadatum

configuration-id

UUID assigned to configuration.

path string
metaname path string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

create or update an existing metadatum

PUT /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}

Tags: Network

create or update an existing metadatum

application/json application/xml

metadatum object that needs to be created or updated.

configuration-id

UUID assigned to configuration.

path string
metaname path string

application/json application/xml

default

Response codes found in response codes.

update an existing metadatum

PATCH /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}

Tags: Network

update an existing metadatum

application/json application/xml

metadatum object that needs to be updated.

configuration-id

UUID assigned to configuration.

path string
metaname path string

application/json application/xml

default

Response codes found in response codes.

delete an existing metadatum

DELETE /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}

Tags: Network

delete an existing metadatum

application/json application/xml

configuration-id

UUID assigned to configuration.

path string
metaname path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/configurations/configuration/{configuration-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

configuration-id

UUID assigned to configuration.

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/configurations/configuration/{configuration-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

configuration-id

UUID assigned to configuration.

path string

application/json application/xml

default

Response codes found in response codes.

returns connectivities

GET /network/connectivities

Tags: Network

returns connectivities

connectivity-id query string
bandwidth-profile-name query string
vpn-type query string
color-aware query string
coupling-flag query string
etht-svc-name query string
access-provider-id query string
access-client-id query string
access-topology-id query string
access-node-id query string
access-ltp-id query string
operational-status query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns connectivity

GET /network/connectivities/connectivity/{connectivity-id}

Tags: Network

returns connectivity

connectivity-id

Uniquely identifies this connectivity by id

path string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

create or update an existing connectivity

PUT /network/connectivities/connectivity/{connectivity-id}

Tags: Network

create or update an existing connectivity

application/json application/xml

connectivity object that needs to be created or updated.

connectivity-id

Uniquely identifies this connectivity by id

path string

application/json application/xml

default

Response codes found in response codes.

update an existing connectivity

PATCH /network/connectivities/connectivity/{connectivity-id}

Tags: Network

update an existing connectivity

application/json application/xml

connectivity object that needs to be updated.

connectivity-id

Uniquely identifies this connectivity by id

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing connectivity

DELETE /network/connectivities/connectivity/{connectivity-id}

Tags: Network

delete an existing connectivity

application/json application/xml

connectivity-id

Uniquely identifies this connectivity by id

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/connectivities/connectivity/{connectivity-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

connectivity-id

Uniquely identifies this connectivity by id

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/connectivities/connectivity/{connectivity-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

connectivity-id

Uniquely identifies this connectivity by id

path string

application/json application/xml

default

Response codes found in response codes.

returns devices

GET /network/devices

Tags: Network

returns devices

device-id query string
esn query string
device-name query string
vendor query string
class query string
type query string
version query string
system-ip query string
system-ipv4 query string
system-ipv6 query string
operational-status query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns device

GET /network/devices/device/{device-id}

Tags: Network

returns device

device-id

Uniquely identifies this device by id

path string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

create or update an existing device

PUT /network/devices/device/{device-id}

Tags: Network

create or update an existing device

application/json application/xml

device object that needs to be created or updated.

device-id

Uniquely identifies this device by id

path string

application/json application/xml

default

Response codes found in response codes.

update an existing device

PATCH /network/devices/device/{device-id}

Tags: Network

update an existing device

application/json application/xml

device object that needs to be updated.

device-id

Uniquely identifies this device by id

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing device

DELETE /network/devices/device/{device-id}

Tags: Network

delete an existing device

application/json application/xml

device-id

Uniquely identifies this device by id

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/devices/device/{device-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

device-id

Uniquely identifies this device by id

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/devices/device/{device-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

device-id

Uniquely identifies this device by id

path string

application/json application/xml

default

Response codes found in response codes.

returns ext-aai-networks

GET /network/ext-aai-networks

Tags: Network

returns ext-aai-networks

aai-id query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns ext-aai-network

GET /network/ext-aai-networks/ext-aai-network/{aai-id}

Tags: Network

returns ext-aai-network

aai-id

Unique ID of the referenced AAI.

path string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

create or update an existing ext-aai-network

PUT /network/ext-aai-networks/ext-aai-network/{aai-id}

Tags: Network

create or update an existing ext-aai-network

application/json application/xml

ext-aai-network object that needs to be created or updated.

aai-id

Unique ID of the referenced AAI.

path string

application/json application/xml

default

Response codes found in response codes.

update an existing ext-aai-network

PATCH /network/ext-aai-networks/ext-aai-network/{aai-id}

Tags: Network

update an existing ext-aai-network

application/json application/xml

ext-aai-network object that needs to be updated.

aai-id

Unique ID of the referenced AAI.

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing ext-aai-network

DELETE /network/ext-aai-networks/ext-aai-network/{aai-id}

Tags: Network

delete an existing ext-aai-network

application/json application/xml

aai-id

Unique ID of the referenced AAI.

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

returns esr-system-info

GET /network/ext-aai-networks/ext-aai-network/{aai-id}/esr-system-info/{esr-system-info-id}

Tags: Network

returns esr-system-info

aai-id

Unique ID of the referenced AAI.

path string
esr-system-info-id

Unique ID of esr system info.

path string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

create or update an existing esr-system-info

PUT /network/ext-aai-networks/ext-aai-network/{aai-id}/esr-system-info/{esr-system-info-id}

Tags: Network

create or update an existing esr-system-info

application/json application/xml

esr-system-info object that needs to be created or updated.

aai-id

Unique ID of the referenced AAI.

path string
esr-system-info-id

Unique ID of esr system info.

path string

application/json application/xml

default

Response codes found in response codes.

update an existing esr-system-info

PATCH /network/ext-aai-networks/ext-aai-network/{aai-id}/esr-system-info/{esr-system-info-id}

Tags: Network

update an existing esr-system-info

application/json application/xml

esr-system-info object that needs to be updated.

aai-id

Unique ID of the referenced AAI.

path string
esr-system-info-id

Unique ID of esr system info.

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing esr-system-info

DELETE /network/ext-aai-networks/ext-aai-network/{aai-id}/esr-system-info/{esr-system-info-id}

Tags: Network

delete an existing esr-system-info

application/json application/xml

aai-id

Unique ID of the referenced AAI.

path string
esr-system-info-id

Unique ID of esr system info.

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/ext-aai-networks/ext-aai-network/{aai-id}/esr-system-info/{esr-system-info-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

aai-id

Unique ID of the referenced AAI.

path string
esr-system-info-id

Unique ID of esr system info.

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/ext-aai-networks/ext-aai-network/{aai-id}/esr-system-info/{esr-system-info-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

aai-id

Unique ID of the referenced AAI.

path string
esr-system-info-id

Unique ID of esr system info.

path string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/ext-aai-networks/ext-aai-network/{aai-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

aai-id

Unique ID of the referenced AAI.

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/ext-aai-networks/ext-aai-network/{aai-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

aai-id

Unique ID of the referenced AAI.

path string

application/json application/xml

default

Response codes found in response codes.

returns forwarding-paths

GET /network/forwarding-paths

Tags: Network

returns forwarding-paths

forwarding-path-id query string
forwarding-path-name query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns forwarding-path

GET /network/forwarding-paths/forwarding-path/{forwarding-path-id}

Tags: Network

returns forwarding-path

forwarding-path-id

Unique ID of this FP

path string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

create or update an existing forwarding-path

PUT /network/forwarding-paths/forwarding-path/{forwarding-path-id}

Tags: Network

create or update an existing forwarding-path

application/json application/xml

forwarding-path object that needs to be created or updated.

forwarding-path-id

Unique ID of this FP

path string

application/json application/xml

default

Response codes found in response codes.

update an existing forwarding-path

PATCH /network/forwarding-paths/forwarding-path/{forwarding-path-id}

Tags: Network

update an existing forwarding-path

application/json application/xml

forwarding-path object that needs to be updated.

forwarding-path-id

Unique ID of this FP

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing forwarding-path

DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}

Tags: Network

delete an existing forwarding-path

application/json application/xml

forwarding-path-id

Unique ID of this FP

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

returns forwarders

GET /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders

Tags: Network

returns forwarders

forwarding-path-id

Unique ID of this FP

path string
sequence query integer

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns forwarder

GET /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}

Tags: Network

returns forwarder

forwarding-path-id

Unique ID of this FP

path string
sequence

Unique ID of this segmentation

path integer

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

create or update an existing forwarder

PUT /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}

Tags: Network

create or update an existing forwarder

application/json application/xml

forwarder object that needs to be created or updated.

forwarding-path-id

Unique ID of this FP

path string
sequence

Unique ID of this segmentation

path integer

application/json application/xml

default

Response codes found in response codes.

update an existing forwarder

PATCH /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}

Tags: Network

update an existing forwarder

application/json application/xml

forwarder object that needs to be updated.

forwarding-path-id

Unique ID of this FP

path string
sequence

Unique ID of this segmentation

path integer

application/json application/xml

default

Response codes found in response codes.

delete an existing forwarder

DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}

Tags: Network

delete an existing forwarder

application/json application/xml

forwarding-path-id

Unique ID of this FP

path string
sequence

Unique ID of this segmentation

path integer
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

forwarding-path-id

Unique ID of this FP

path string
sequence

Unique ID of this segmentation

path integer

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

forwarding-path-id

Unique ID of this FP

path string
sequence

Unique ID of this segmentation

path integer

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/forwarding-paths/forwarding-path/{forwarding-path-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

forwarding-path-id

Unique ID of this FP

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/forwarding-paths/forwarding-path/{forwarding-path-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

forwarding-path-id

Unique ID of this FP

path string

application/json application/xml

default

Response codes found in response codes.

returns generic-vnfs

GET /network/generic-vnfs

Tags: Network

returns generic-vnfs

vnf-id query string
vnf-name query string
vnf-name2 query string
vnf-type query string
service-id query string
regional-resource-zone query string
prov-status query string
heat-stack-id query string
in-maint query boolean
is-closed-loop-disabled query boolean
model-invariant-id query string
model-version-id query string
widget-model-id query string
widget-model-version query string
nf-type query string
nf-function query string
nf-role query string
nf-naming-code query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns generic-vnf

GET /network/generic-vnfs/generic-vnf/{vnf-id}

Tags: Network

returns generic-vnf

vnf-id

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

path string

application/json application/xml

200 OK

successful operation

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.

vnf-id

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

path string

application/json application/xml

default

Response codes found in response codes.

update an existing generic-vnf

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}

Tags: Network

update an existing generic-vnf

application/json application/xml

generic-vnf object that needs to be updated.

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
group-uuid query string
resource-uuid query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns entitlement

GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

Tags: Network

returns entitlement

vnf-id

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

path string
group-uuid

Unique ID for the entitlement group the resource comes from, should be uuid.

path string
resource-uuid

Unique ID of an entitlement resource.

path string

application/json application/xml

200 OK

successful operation

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.

vnf-id

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

path string
group-uuid

Unique ID for the entitlement group the resource comes from, should be uuid.

path string
resource-uuid

Unique ID of an entitlement resource.

path string

application/json application/xml

default

Response codes found in response codes.

update an existing entitlement

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

Tags: Network

update an existing entitlement

application/json application/xml

entitlement object that needs to be updated.

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.

vnf-id

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

path string
group-uuid

Unique ID for the entitlement group the resource comes from, should be uuid.

path string
resource-uuid

Unique ID of an entitlement resource.

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

vnf-id

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

path string
group-uuid

Unique ID for the entitlement group the resource comes from, should be uuid.

path string
resource-uuid

Unique ID of an entitlement resource.

path string

application/json application/xml

default

Response codes found in response codes.

returns l-interfaces

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces

Tags: Network

returns l-interfaces

vnf-id

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

path string
interface-name query string
interface-id query string
macaddr query string
network-name query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns l-interface

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

Tags: Network

returns l-interface

vnf-id

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

path string
interface-name

Name given to the interface

path string

application/json application/xml

200 OK

successful operation

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.

vnf-id

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

path string
interface-name

Name given to the interface

path string

application/json application/xml

default

Response codes found in response codes.

update an existing l-interface

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

Tags: Network

update an existing l-interface

application/json application/xml

l-interface object that needs to be updated.

vnf-id

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

path string
interface-name

Name given to the interface

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing l-interface

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

Tags: Network

delete an existing l-interface

application/json application/xml

vnf-id

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

path string
interface-name

Name given to the interface

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

returns l3-interface-ipv4-address-list

vnf-id

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

path string
interface-name

Name given to the interface

path string
l3-interface-ipv4-address

IP address

path string

application/json application/xml

200 OK

successful operation

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.

vnf-id

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

path string
interface-name

Name given to the interface

path string
l3-interface-ipv4-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

update an existing l3-interface-ipv4-address-list

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

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.

vnf-id

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

path string
interface-name

Name given to the interface

path string
l3-interface-ipv4-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

vnf-id

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

path string
interface-name

Name given to the interface

path string
l3-interface-ipv4-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

returns l3-interface-ipv6-address-list

vnf-id

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

path string
interface-name

Name given to the interface

path string
l3-interface-ipv6-address

IP address

path string

application/json application/xml

200 OK

successful operation

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.

vnf-id

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

path string
interface-name

Name given to the interface

path string
l3-interface-ipv6-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

update an existing l3-interface-ipv6-address-list

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

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.

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.

vnf-id

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

path string
interface-name

Name given to the interface

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

vnf-id

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

path string
interface-name

Name given to the interface

path string

application/json application/xml

default

Response codes found in response codes.

returns sriov-vfs

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs

Tags: Network

returns sriov-vfs

vnf-id

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

path string
interface-name

Name given to the interface

path string
pci-id query string
vf-vlan-filter query string
vf-mac-filter query string
vf-vlan-strip query boolean
neutron-network-id query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns sriov-vf

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

returns sriov-vf

vnf-id

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

path string
interface-name

Name given to the interface

path string
pci-id

PCI ID used to identify the sriov-vf

path string

application/json application/xml

200 OK

successful operation

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.

vnf-id

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

path string
interface-name

Name given to the interface

path string
pci-id

PCI ID used to identify the sriov-vf

path string

application/json application/xml

default

Response codes found in response codes.

update an existing sriov-vf

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

update an existing sriov-vf

application/json application/xml

sriov-vf object that needs to be updated.

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.

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
vlan-interface query string
vlan-id-inner query integer
vpn-key query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns vlan

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

returns vlan

vnf-id

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

path string
interface-name

Name given to the interface

path string
vlan-interface

String that identifies the interface

path string

application/json application/xml

200 OK

successful operation

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.

vnf-id

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

path string
interface-name

Name given to the interface

path string
vlan-interface

String that identifies the interface

path string

application/json application/xml

default

Response codes found in response codes.

update an existing vlan

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

update an existing vlan

application/json application/xml

vlan object that needs to be updated.

vnf-id

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

path string
interface-name

Name given to the interface

path string
vlan-interface

String that identifies the interface

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing vlan

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

delete an existing vlan

application/json application/xml

vnf-id

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

path string
interface-name

Name given to the interface

path string
vlan-interface

String that identifies the interface

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

returns l3-interface-ipv4-address-list

vnf-id

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

path string
interface-name

Name given to the interface

path string
vlan-interface

String that identifies the interface

path string
l3-interface-ipv4-address

IP address

path string

application/json application/xml

200 OK

successful operation

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.

vnf-id

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

path string
interface-name

Name given to the interface

path string
vlan-interface

String that identifies the interface

path string
l3-interface-ipv4-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

update an existing l3-interface-ipv4-address-list

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

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.

vnf-id

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

path string
interface-name

Name given to the interface

path string
vlan-interface

String that identifies the interface

path string
l3-interface-ipv4-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

vnf-id

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

path string
interface-name

Name given to the interface

path string
vlan-interface

String that identifies the interface

path string
l3-interface-ipv4-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

returns l3-interface-ipv6-address-list

vnf-id

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

path string
interface-name

Name given to the interface

path string
vlan-interface

String that identifies the interface

path string
l3-interface-ipv6-address

IP address

path string

application/json application/xml

200 OK

successful operation

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.

vnf-id

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

path string
interface-name

Name given to the interface

path string
vlan-interface

String that identifies the interface

path string
l3-interface-ipv6-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

update an existing l3-interface-ipv6-address-list

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

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.

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.

vnf-id

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

path string
interface-name

Name given to the interface

path string
vlan-interface

String that identifies the interface

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

vnf-id

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

path string
interface-name

Name given to the interface

path string
vlan-interface

String that identifies the interface

path string

application/json application/xml

default

Response codes found in response codes.

returns lag-interfaces

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces

Tags: Network

returns lag-interfaces

vnf-id

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

path string
interface-name query string
interface-id query string
interface-role query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns lag-interface

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

Tags: Network

returns lag-interface

vnf-id

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

path string
interface-name

Name that identifies the link aggregate interface

path string

application/json application/xml

200 OK

successful operation

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.

vnf-id

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

path string
interface-name

Name that identifies the link aggregate interface

path string

application/json application/xml

default

Response codes found in response codes.

update an existing lag-interface

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

Tags: Network

update an existing lag-interface

application/json application/xml

lag-interface object that needs to be updated.

vnf-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
interface-name query string
interface-id query string
macaddr query string
network-name query string

application/json application/xml

200 OK

successful operation

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

application/json application/xml

200 OK

successful operation

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.

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

update an existing l-interface

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: Network

update an existing l-interface

application/json application/xml

l-interface object that needs to be updated.

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

application/json application/xml

200 OK

successful operation

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.

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

update an existing l3-interface-ipv4-address-list

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

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

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

application/json application/xml

200 OK

successful operation

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.

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

update an existing l3-interface-ipv6-address-list

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

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

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

vnf-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
pci-id query string
vf-vlan-filter query string
vf-mac-filter query string
vf-vlan-strip query boolean
neutron-network-id query string

application/json application/xml

200 OK

successful operation

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

application/json application/xml

200 OK

successful operation

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.

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

update an existing sriov-vf

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

update an existing sriov-vf

application/json application/xml

sriov-vf object that needs to be updated.

vnf-id

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

path string
interface-name

Name that identifies the link aggregate interface

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

vnf-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
vlan-interface query string
vlan-id-inner query integer
vpn-key query string

application/json application/xml

200 OK

successful operation

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

application/json application/xml

200 OK

successful operation

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.

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

update an existing vlan

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

update an existing vlan

application/json application/xml

vlan object that needs to be updated.

vnf-id

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

path string
interface-name

Name that identifies the link aggregate interface

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

application/json application/xml

200 OK

successful operation

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.

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

update an existing l3-interface-ipv4-address-list

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

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

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

application/json application/xml

200 OK

successful operation

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.

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

update an existing l3-interface-ipv6-address-list

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

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

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

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

vnf-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
group-uuid query string
resource-uuid query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns license

GET /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

Tags: Network

returns license

vnf-id

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

path string
group-uuid

Unique ID for the license group the resource belongs to, should be uuid.

path string
resource-uuid

Unique ID of a license resource.

path string

application/json application/xml

200 OK

successful operation

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.

vnf-id

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

path string
group-uuid

Unique ID for the license group the resource belongs to, should be uuid.

path string
resource-uuid

Unique ID of a license resource.

path string

application/json application/xml

default

Response codes found in response codes.

update an existing license

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

Tags: Network

update an existing license

application/json application/xml

license object that needs to be updated.

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.

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.

vnf-id

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

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

vnf-id

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

path string

application/json application/xml

default

Response codes found in response codes.

returns vf-modules

GET /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules

Tags: Network

returns vf-modules

vnf-id

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

path string
vf-module-id query string
vf-module-name query string
heat-stack-id query string
model-invariant-id query string
model-version-id query string
widget-model-id query string
widget-model-version query string
contrail-service-instance-fqdn query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns vf-module

GET /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

Tags: Network

returns vf-module

vnf-id

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

path string
vf-module-id

Unique ID of vf-module.

path string

application/json application/xml

200 OK

successful operation

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.

vnf-id

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

path string
vf-module-id

Unique ID of vf-module.

path string

application/json application/xml

default

Response codes found in response codes.

update an existing vf-module

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

Tags: Network

update an existing vf-module

application/json application/xml

vf-module object that needs to be updated.

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.

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

id query string
model-invariant-id query string
model-version-id query string
description query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns instance-group

GET /network/instance-groups/instance-group/{id}

Tags: Network

returns instance-group

id

Instance Group ID, UUID assigned to this instance.

path string

application/json application/xml

200 OK

successful operation

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.

id

Instance Group ID, UUID assigned to this instance.

path string

application/json application/xml

default

Response codes found in response codes.

update an existing instance-group

PATCH /network/instance-groups/instance-group/{id}

Tags: Network

update an existing instance-group

application/json application/xml

instance-group object that needs to be updated.

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.

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

ipsec-configuration-id query string

application/json application/xml

200 OK

successful operation

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

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

UUID of this configuration

path string

application/json application/xml

default

Response codes found in response codes.

update an existing ipsec-configuration

PATCH /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

Tags: Network

update an existing ipsec-configuration

application/json application/xml

ipsec-configuration object that needs to be updated.

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.

ipsec-configuration-id

UUID of this configuration

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

ipsec-configuration-id

UUID of this configuration

path string

application/json application/xml

default

Response codes found in response codes.

returns vig-servers

GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers

Tags: Network

returns vig-servers

ipsec-configuration-id

UUID of this configuration

path string
vig-address-type query string

application/json application/xml

200 OK

successful operation

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

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.

ipsec-configuration-id

UUID of this configuration

path string
vig-address-type

indicates whether the VIG is for AVPN or INTERNET

path string

application/json application/xml

default

Response codes found in response codes.

update an existing vig-server

PATCH /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

Tags: Network

update an existing vig-server

application/json application/xml

vig-server object that needs to be updated.

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.

ipsec-configuration-id

UUID of this configuration

path string
vig-address-type

indicates whether the VIG is for AVPN or INTERNET

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

ipsec-configuration-id

UUID of this configuration

path string
vig-address-type

indicates whether the VIG is for AVPN or INTERNET

path string

application/json application/xml

default

Response codes found in response codes.

returns l3-networks

GET /network/l3-networks

Tags: Network

returns l3-networks

network-id query string
network-name query string
network-role query string
service-id query string
heat-stack-id query string
contrail-network-fqdn query string
model-invariant-id query string
model-version-id query string
widget-model-id query string
widget-model-version query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns l3-network

GET /network/l3-networks/l3-network/{network-id}

Tags: Network

returns l3-network

network-id

Network ID, should be uuid. Unique across A&AI.

path string

application/json application/xml

200 OK

successful operation

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.

network-id

Network ID, should be uuid. Unique across A&AI.

path string

application/json application/xml

default

Response codes found in response codes.

update an existing l3-network

PATCH /network/l3-networks/l3-network/{network-id}

Tags: Network

update an existing l3-network

application/json application/xml

l3-network object that needs to be updated.

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
vlan-id-inner query integer

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns ctag-assignment

GET /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

Tags: Network

returns ctag-assignment

network-id

Network ID, should be uuid. Unique across A&AI.

path string
vlan-id-inner

id.

path integer

application/json application/xml

200 OK

successful operation

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.

network-id

Network ID, should be uuid. Unique across A&AI.

path string
vlan-id-inner

id.

path integer

application/json application/xml

default

Response codes found in response codes.

update an existing ctag-assignment

PATCH /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

Tags: Network

update an existing ctag-assignment

application/json application/xml

ctag-assignment object that needs to be updated.

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.

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.

network-id

Network ID, should be uuid. Unique across A&AI.

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/l3-networks/l3-network/{network-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

network-id

Network ID, should be uuid. Unique across A&AI.

path string

application/json application/xml

default

Response codes found in response codes.

returns segmentation-assignments

GET /network/l3-networks/l3-network/{network-id}/segmentation-assignments

Tags: Network

returns segmentation-assignments

network-id

Network ID, should be uuid. Unique across A&AI.

path string
segmentation-id query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns segmentation-assignment

GET /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

Tags: Network

returns segmentation-assignment

network-id

Network ID, should be uuid. Unique across A&AI.

path string
segmentation-id

Route Table Reference id, UUID assigned to this instance.

path string

application/json application/xml

200 OK

successful operation

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.

network-id

Network ID, should be uuid. Unique across A&AI.

path string
segmentation-id

Route Table Reference id, UUID assigned to this instance.

path string

application/json application/xml

default

Response codes found in response codes.

update an existing segmentation-assignment

PATCH /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

Tags: Network

update an existing segmentation-assignment

application/json application/xml

segmentation-assignment object that needs to be updated.

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.

network-id

Network ID, should be uuid. Unique across A&AI.

path string
segmentation-id

Route Table Reference id, UUID assigned to this instance.

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

network-id

Network ID, should be uuid. Unique across A&AI.

path string
segmentation-id

Route Table Reference id, UUID assigned to this instance.

path string

application/json application/xml

default

Response codes found in response codes.

returns subnets

GET /network/l3-networks/l3-network/{network-id}/subnets

Tags: Network

returns subnets

network-id

Network ID, should be uuid. Unique across A&AI.

path string
subnet-id query string
subnet-name query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns subnet

GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

Tags: Network

returns subnet

network-id

Network ID, should be uuid. Unique across A&AI.

path string
subnet-id

Subnet ID, should be UUID.

path string

application/json application/xml

200 OK

successful operation

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.

network-id

Network ID, should be uuid. Unique across A&AI.

path string
subnet-id

Subnet ID, should be UUID.

path string

application/json application/xml

default

Response codes found in response codes.

update an existing subnet

PATCH /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

Tags: Network

update an existing subnet

application/json application/xml

subnet object that needs to be updated.

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
host-route-id query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns host-route

GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

Tags: Network

returns host-route

network-id

Network ID, should be uuid. Unique across A&AI.

path string
subnet-id

Subnet ID, should be UUID.

path string
host-route-id

host-route id

path string

application/json application/xml

200 OK

successful operation

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.

network-id

Network ID, should be uuid. Unique across A&AI.

path string
subnet-id

Subnet ID, should be UUID.

path string
host-route-id

host-route id

path string

application/json application/xml

default

Response codes found in response codes.

update an existing host-route

PATCH /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

Tags: Network

update an existing host-route

application/json application/xml

host-route object that needs to be updated.

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.

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.

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 lan-port-configs

GET /network/lan-port-configs

Tags: Network

returns lan-port-configs

lan-port-config-id query string
lan-port-config-name query string
device-id query string
port-id query string
ipv4-address query string
ipv6-address query string
vlan-tag query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns lan-port-config

GET /network/lan-port-configs/lan-port-config/{lan-port-config-id}

Tags: Network

returns lan-port-config

lan-port-config-id

Uniquely identifies this lan-port-config by id

path string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

create or update an existing lan-port-config

PUT /network/lan-port-configs/lan-port-config/{lan-port-config-id}

Tags: Network

create or update an existing lan-port-config

application/json application/xml

lan-port-config object that needs to be created or updated.

lan-port-config-id

Uniquely identifies this lan-port-config by id

path string

application/json application/xml

default

Response codes found in response codes.

update an existing lan-port-config

PATCH /network/lan-port-configs/lan-port-config/{lan-port-config-id}

Tags: Network

update an existing lan-port-config

application/json application/xml

lan-port-config object that needs to be updated.

lan-port-config-id

Uniquely identifies this lan-port-config by id

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing lan-port-config

DELETE /network/lan-port-configs/lan-port-config/{lan-port-config-id}

Tags: Network

delete an existing lan-port-config

application/json application/xml

lan-port-config-id

Uniquely identifies this lan-port-config by id

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

returns dhcp-services

GET /network/lan-port-configs/lan-port-config/{lan-port-config-id}/dhcp-services

Tags: Network

returns dhcp-services

lan-port-config-id

Uniquely identifies this lan-port-config by id

path string
dhcp-service-id query string
server-ipv4-address query string
server-ipv6-address query string
dhcp-service-type query string
domain-name query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns dhcp-service

GET /network/lan-port-configs/lan-port-config/{lan-port-config-id}/dhcp-services/dhcp-service/{dhcp-service-id}

Tags: Network

returns dhcp-service

lan-port-config-id

Uniquely identifies this lan-port-config by id

path string
dhcp-service-id

Uniquely identifies this dhcp-service by id

path string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

create or update an existing dhcp-service

PUT /network/lan-port-configs/lan-port-config/{lan-port-config-id}/dhcp-services/dhcp-service/{dhcp-service-id}

Tags: Network

create or update an existing dhcp-service

application/json application/xml

dhcp-service object that needs to be created or updated.

lan-port-config-id

Uniquely identifies this lan-port-config by id

path string
dhcp-service-id

Uniquely identifies this dhcp-service by id

path string

application/json application/xml

default

Response codes found in response codes.

update an existing dhcp-service

PATCH /network/lan-port-configs/lan-port-config/{lan-port-config-id}/dhcp-services/dhcp-service/{dhcp-service-id}

Tags: Network

update an existing dhcp-service

application/json application/xml

dhcp-service object that needs to be updated.

lan-port-config-id

Uniquely identifies this lan-port-config by id

path string
dhcp-service-id

Uniquely identifies this dhcp-service by id

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing dhcp-service

DELETE /network/lan-port-configs/lan-port-config/{lan-port-config-id}/dhcp-services/dhcp-service/{dhcp-service-id}

Tags: Network

delete an existing dhcp-service

application/json application/xml

lan-port-config-id

Uniquely identifies this lan-port-config by id

path string
dhcp-service-id

Uniquely identifies this dhcp-service by id

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/lan-port-configs/lan-port-config/{lan-port-config-id}/dhcp-services/dhcp-service/{dhcp-service-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

lan-port-config-id

Uniquely identifies this lan-port-config by id

path string
dhcp-service-id

Uniquely identifies this dhcp-service by id

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/lan-port-configs/lan-port-config/{lan-port-config-id}/dhcp-services/dhcp-service/{dhcp-service-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

lan-port-config-id

Uniquely identifies this lan-port-config by id

path string
dhcp-service-id

Uniquely identifies this dhcp-service by id

path string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/lan-port-configs/lan-port-config/{lan-port-config-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

lan-port-config-id

Uniquely identifies this lan-port-config by id

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/lan-port-configs/lan-port-config/{lan-port-config-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

lan-port-config-id

Uniquely identifies this lan-port-config by id

path string

application/json application/xml

default

Response codes found in response codes.

returns multicast-configurations

GET /network/multicast-configurations

Tags: Network

returns multicast-configurations

multicast-configuration-id query string

application/json application/xml

200 OK

successful operation

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

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

Unique id of multicast configuration.

path string

application/json application/xml

default

Response codes found in response codes.

update an existing multicast-configuration

PATCH /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

Tags: Network

update an existing multicast-configuration

application/json application/xml

multicast-configuration object that needs to be updated.

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.

multicast-configuration-id

Unique id of multicast configuration.

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

multicast-configuration-id

Unique id of multicast configuration.

path string

application/json application/xml

default

Response codes found in response codes.

returns network-policies

GET /network/network-policies

Tags: Network

returns network-policies

network-policy-id query string
network-policy-fqdn query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns network-policy

GET /network/network-policies/network-policy/{network-policy-id}

Tags: Network

returns network-policy

network-policy-id

UUID representing unique key to this instance

path string

application/json application/xml

200 OK

successful operation

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

UUID representing unique key to this instance

path string

application/json application/xml

default

Response codes found in response codes.

update an existing network-policy

PATCH /network/network-policies/network-policy/{network-policy-id}

Tags: Network

update an existing network-policy

application/json application/xml

network-policy object that needs to be updated.

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.

network-policy-id

UUID representing unique key to this instance

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

network-policy-id

UUID representing unique key to this instance

path string

application/json application/xml

default

Response codes found in response codes.

returns network-resources

GET /network/network-resources

Tags: Network

returns network-resources

network-id query string
provider-id query string
client-id query string
te-topo-id query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns network-resource

GET /network/network-resources/network-resource/{network-id}

Tags: Network

returns network-resource

network-id

Uniquely identifies this network-resource by id

path string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

create or update an existing network-resource

PUT /network/network-resources/network-resource/{network-id}

Tags: Network

create or update an existing network-resource

application/json application/xml

network-resource object that needs to be created or updated.

network-id

Uniquely identifies this network-resource by id

path string

application/json application/xml

default

Response codes found in response codes.

update an existing network-resource

PATCH /network/network-resources/network-resource/{network-id}

Tags: Network

update an existing network-resource

application/json application/xml

network-resource object that needs to be updated.

network-id

Uniquely identifies this network-resource by id

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing network-resource

DELETE /network/network-resources/network-resource/{network-id}

Tags: Network

delete an existing network-resource

application/json application/xml

network-id

Uniquely identifies this network-resource by id

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/network-resources/network-resource/{network-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

network-id

Uniquely identifies this network-resource by id

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/network-resources/network-resource/{network-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

network-id

Uniquely identifies this network-resource by id

path string

application/json application/xml

default

Response codes found in response codes.

returns newvces

GET /network/newvces

Tags: Network

returns newvces

vnf-id2 query string
vnf-name query string
vnf-name2 query string
vnf-type query string
prov-status query string
heat-stack-id query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns newvce

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

Tags: Network

returns newvce

vnf-id2

Unique id of VNF, can't use same attribute name right now until we promote this new object

path string

application/json application/xml

200 OK

successful operation

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.

vnf-id2

Unique id of VNF, can't use same attribute name right now until we promote this new object

path string

application/json application/xml

default

Response codes found in response codes.

update an existing newvce

PATCH /network/newvces/newvce/{vnf-id2}

Tags: Network

update an existing newvce

application/json application/xml

newvce object that needs to be updated.

vnf-id2

Unique id of VNF, can't use same attribute name right now until we promote this new object

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing newvce

DELETE /network/newvces/newvce/{vnf-id2}

Tags: Network

delete an existing newvce

application/json application/xml

vnf-id2

Unique id of VNF, can't use same attribute name right now until we promote this new object

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

returns l-interfaces

GET /network/newvces/newvce/{vnf-id2}/l-interfaces

Tags: Network

returns l-interfaces

vnf-id2

Unique id of VNF, can't use same attribute name right now until we promote this new object

path string
interface-name query string
interface-id query string
macaddr query string
network-name query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns l-interface

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

Tags: Network

returns l-interface

vnf-id2

Unique id of VNF, can't use same attribute name right now until we promote this new object

path string
interface-name

Name given to the interface

path string

application/json application/xml

200 OK

successful operation

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.

vnf-id2

Unique id of VNF, can't use same attribute name right now until we promote this new object

path string
interface-name

Name given to the interface

path string

application/json application/xml

default

Response codes found in response codes.

update an existing l-interface

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

Tags: Network

update an existing l-interface

application/json application/xml

l-interface object that needs to be updated.

vnf-id2

Unique id of VNF, can't use same attribute name right now until we promote this new object

path string
interface-name

Name given to the interface

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing l-interface

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

Tags: Network

delete an existing l-interface

application/json application/xml

vnf-id2

Unique id of VNF, can't use same attribute name right now until we promote this new object

path string
interface-name

Name given to the interface

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

returns l3-interface-ipv4-address-list

vnf-id2

Unique id of VNF, can't use same attribute name right now until we promote this new object

path string
interface-name

Name given to the interface

path string
l3-interface-ipv4-address

IP address

path string

application/json application/xml

200 OK

successful operation

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.

vnf-id2

Unique id of VNF, can't use same attribute name right now until we promote this new object

path string
interface-name

Name given to the interface

path string
l3-interface-ipv4-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

update an existing l3-interface-ipv4-address-list

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

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.

vnf-id2

Unique id of VNF, can't use same attribute name right now until we promote this new object

path string
interface-name

Name given to the interface

path string
l3-interface-ipv4-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

vnf-id2

Unique id of VNF, can't use same attribute name right now until we promote this new object

path string
interface-name

Name given to the interface

path string
l3-interface-ipv4-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

returns l3-interface-ipv6-address-list

vnf-id2

Unique id of VNF, can't use same attribute name right now until we promote this new object

path string
interface-name

Name given to the interface

path string
l3-interface-ipv6-address

IP address

path string

application/json application/xml

200 OK

successful operation

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.

vnf-id2

Unique id of VNF, can't use same attribute name right now until we promote this new object

path string
interface-name

Name given to the interface

path string
l3-interface-ipv6-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

update an existing l3-interface-ipv6-address-list

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

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.

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.

vnf-id2

Unique id of VNF, can't use same attribute name right now until we promote this new object

path string
interface-name

Name given to the interface

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

vnf-id2

Unique id of VNF, can't use same attribute name right now until we promote this new object

path string
interface-name

Name given to the interface

path string

application/json application/xml

default

Response codes found in response codes.

returns sriov-vfs

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs

Tags: Network

returns sriov-vfs

vnf-id2

Unique id of VNF, can't use same attribute name right now until we promote this new object

path string
interface-name

Name given to the interface

path string
pci-id query string
vf-vlan-filter query string
vf-mac-filter query string
vf-vlan-strip query boolean
neutron-network-id query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns sriov-vf

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

returns sriov-vf

vnf-id2

Unique id of VNF, can't use same attribute name right now until we promote this new object

path string
interface-name

Name given to the interface

path string
pci-id

PCI ID used to identify the sriov-vf

path string

application/json application/xml

200 OK

successful operation

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.

vnf-id2

Unique id of VNF, can't use same attribute name right now until we promote this new object

path string
interface-name

Name given to the interface

path string
pci-id

PCI ID used to identify the sriov-vf

path string

application/json application/xml

default

Response codes found in response codes.

update an existing sriov-vf

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network

update an existing sriov-vf

application/json application/xml

sriov-vf object that needs to be updated.

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.

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
vlan-interface query string
vlan-id-inner query integer
vpn-key query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns vlan

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

returns vlan

vnf-id2

Unique id of VNF, can't use same attribute name right now until we promote this new object

path string
interface-name

Name given to the interface

path string
vlan-interface

String that identifies the interface

path string

application/json application/xml

200 OK

successful operation

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.

vnf-id2

Unique id of VNF, can't use same attribute name right now until we promote this new object

path string
interface-name

Name given to the interface

path string
vlan-interface

String that identifies the interface

path string

application/json application/xml

default

Response codes found in response codes.

update an existing vlan

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

update an existing vlan

application/json application/xml

vlan object that needs to be updated.

vnf-id2

Unique id of VNF, can't use same attribute name right now until we promote this new object

path string
interface-name

Name given to the interface

path string
vlan-interface

String that identifies the interface

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing vlan

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

delete an existing vlan

application/json application/xml

vnf-id2

Unique id of VNF, can't use same attribute name right now until we promote this new object

path string
interface-name

Name given to the interface

path string
vlan-interface

String that identifies the interface

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

returns l3-interface-ipv4-address-list

vnf-id2

Unique id of VNF, can't use same attribute name right now until we promote this new object

path string
interface-name

Name given to the interface

path string
vlan-interface

String that identifies the interface

path string
l3-interface-ipv4-address

IP address

path string

application/json application/xml

200 OK

successful operation

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.

vnf-id2

Unique id of VNF, can't use same attribute name right now until we promote this new object

path string
interface-name

Name given to the interface

path string
vlan-interface

String that identifies the interface

path string
l3-interface-ipv4-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

update an existing l3-interface-ipv4-address-list

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

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.

vnf-id2

Unique id of VNF, can't use same attribute name right now until we promote this new object

path string
interface-name

Name given to the interface

path string
vlan-interface

String that identifies the interface

path string
l3-interface-ipv4-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

vnf-id2

Unique id of VNF, can't use same attribute name right now until we promote this new object

path string
interface-name

Name given to the interface

path string
vlan-interface

String that identifies the interface

path string
l3-interface-ipv4-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

returns l3-interface-ipv6-address-list

vnf-id2

Unique id of VNF, can't use same attribute name right now until we promote this new object

path string
interface-name

Name given to the interface

path string
vlan-interface

String that identifies the interface

path string
l3-interface-ipv6-address

IP address

path string

application/json application/xml

200 OK

successful operation

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.

vnf-id2

Unique id of VNF, can't use same attribute name right now until we promote this new object

path string
interface-name

Name given to the interface

path string
vlan-interface

String that identifies the interface

path string
l3-interface-ipv6-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

update an existing l3-interface-ipv6-address-list

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

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.

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.

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.

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 pnfs

GET /network/pnfs

Tags: Network

returns pnfs

pnf-name query string
inv-status query string
admin-status query string
operational-status query string
model-invariant-id query string
model-version-id query string

application/json application/xml

200 OK

successful operation

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

application/json application/xml

200 OK

successful operation

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

unique name of Physical Network Function.

path string

application/json application/xml

default

Response codes found in response codes.

update an existing pnf

PATCH /network/pnfs/pnf/{pnf-name}

Tags: Network

update an existing pnf

application/json application/xml

pnf object that needs to be updated.

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
interface-name query string
interface-id query string
interface-role query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns lag-interface

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

Tags: Network

returns lag-interface

pnf-name

unique name of Physical Network Function.

path string
interface-name

Name that identifies the link aggregate interface

path string

application/json application/xml

200 OK

successful operation

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.

pnf-name

unique name of Physical Network Function.

path string
interface-name

Name that identifies the link aggregate interface

path string

application/json application/xml

default

Response codes found in response codes.

update an existing lag-interface

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

Tags: Network

update an existing lag-interface

application/json application/xml

lag-interface object that needs to be updated.

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
interface-name query string
interface-id query string
macaddr query string
network-name query string

application/json application/xml

200 OK

successful operation

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing l-interface

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

Tags: Network

update an existing l-interface

application/json application/xml

l-interface object that needs to be updated.

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing l3-interface-ipv4-address-list

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

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

pnf-name

unique name of Physical Network Function.

path string
interface-name

Name that identifies the link aggregate interface

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

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing l3-interface-ipv6-address-list

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

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

pnf-name

unique name of Physical Network Function.

path string
interface-name

Name that identifies the link aggregate interface

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

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.

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
pci-id query string
vf-vlan-filter query string
vf-mac-filter query string
vf-vlan-strip query boolean
neutron-network-id query string

application/json application/xml

200 OK

successful operation

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing sriov-vf

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

update an existing sriov-vf

application/json application/xml

sriov-vf object that needs to be updated.

pnf-name

unique name of Physical Network Function.

path string
interface-name

Name that identifies the link aggregate interface

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

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
vlan-interface query string
vlan-id-inner query integer
vpn-key query string

application/json application/xml

200 OK

successful operation

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing vlan

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

update an existing vlan

application/json application/xml

vlan object that needs to be updated.

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing l3-interface-ipv4-address-list

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

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

pnf-name

unique name of Physical Network Function.

path string
interface-name

Name that identifies the link aggregate interface

path string
interface-name

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.

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing l3-interface-ipv6-address-list

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

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

pnf-name

unique name of Physical Network Function.

path string
interface-name

Name that identifies the link aggregate interface

path string
interface-name

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.

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.

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.

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
interface-name query string
prov-status query string
operational-status query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns p-interface

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

Tags: Network

returns p-interface

pnf-name

unique name of Physical Network Function.

path string
interface-name

Name that identifies the physical interface

path string

application/json application/xml

200 OK

successful operation

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.

pnf-name

unique name of Physical Network Function.

path string
interface-name

Name that identifies the physical interface

path string

application/json application/xml

default

Response codes found in response codes.

update an existing p-interface

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

Tags: Network

update an existing p-interface

application/json application/xml

p-interface object that needs to be updated.

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
interface-name query string
interface-id query string
macaddr query string
network-name query string

application/json application/xml

200 OK

successful operation

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing l-interface

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

Tags: Network

update an existing l-interface

application/json application/xml

l-interface object that needs to be updated.

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing l3-interface-ipv4-address-list

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

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

pnf-name

unique name of Physical Network Function.

path string
interface-name

Name that identifies the physical interface

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

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing l3-interface-ipv6-address-list

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

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

pnf-name

unique name of Physical Network Function.

path string
interface-name

Name that identifies the physical interface

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

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.

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
pci-id query string
vf-vlan-filter query string
vf-mac-filter query string
vf-vlan-strip query boolean
neutron-network-id query string

application/json application/xml

200 OK

successful operation

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing sriov-vf

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

update an existing sriov-vf

application/json application/xml

sriov-vf object that needs to be updated.

pnf-name

unique name of Physical Network Function.

path string
interface-name

Name that identifies the physical interface

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

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
vlan-interface query string
vlan-id-inner query integer
vpn-key query string

application/json application/xml

200 OK

successful operation

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing vlan

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network

update an existing vlan

application/json application/xml

vlan object that needs to be updated.

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing l3-interface-ipv4-address-list

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

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

pnf-name

unique name of Physical Network Function.

path string
interface-name

Name that identifies the physical interface

path string
interface-name

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.

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing l3-interface-ipv6-address-list

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

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

pnf-name

unique name of Physical Network Function.

path string
interface-name

Name that identifies the physical interface

path string
interface-name

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.

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.

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.

pnf-name

unique name of Physical Network Function.

path string
interface-name

Name that identifies the physical interface

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

pnf-name

unique name of Physical Network Function.

path string
interface-name

Name that identifies the physical interface

path string

application/json application/xml

default

Response codes found in response codes.

returns sriov-pfs

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs

Tags: Network

returns sriov-pfs

pnf-name

unique name of Physical Network Function.

path string
interface-name

Name that identifies the physical interface

path string
pf-pci-id query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns sriov-pf

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

Tags: Network

returns sriov-pf

pnf-name

unique name of Physical Network Function.

path string
interface-name

Name that identifies the physical interface

path string
pf-pci-id

Identifier for the sriov-pf

path string

application/json application/xml

200 OK

successful operation

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.

pnf-name

unique name of Physical Network Function.

path string
interface-name

Name that identifies the physical interface

path string
pf-pci-id

Identifier for the sriov-pf

path string

application/json application/xml

default

Response codes found in response codes.

update an existing sriov-pf

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

Tags: Network

update an existing sriov-pf

application/json application/xml

sriov-pf object that needs to be updated.

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.

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.

pnf-name

unique name of Physical Network Function.

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

pnf-name

unique name of Physical Network Function.

path string

application/json application/xml

default

Response codes found in response codes.

returns software-versions

GET /network/pnfs/pnf/{pnf-name}/software-versions

Tags: Network

returns software-versions

pnf-name

unique name of Physical Network Function.

path string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns software-version

GET /network/pnfs/pnf/{pnf-name}/software-versions/software-version/{software-version-id}

Tags: Network

returns software-version

pnf-name

unique name of Physical Network Function.

path string
software-version-id

Identifier of the software version

path string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

create or update an existing software-version

PUT /network/pnfs/pnf/{pnf-name}/software-versions/software-version/{software-version-id}

Tags: Network

create or update an existing software-version

application/json application/xml

software-version object that needs to be created or updated.

pnf-name

unique name of Physical Network Function.

path string
software-version-id

Identifier of the software version

path string

application/json application/xml

default

Response codes found in response codes.

update an existing software-version

PATCH /network/pnfs/pnf/{pnf-name}/software-versions/software-version/{software-version-id}

Tags: Network

update an existing software-version

application/json application/xml

software-version object that needs to be updated.

pnf-name

unique name of Physical Network Function.

path string
software-version-id

Identifier of the software version

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing software-version

DELETE /network/pnfs/pnf/{pnf-name}/software-versions/software-version/{software-version-id}

Tags: Network

delete an existing software-version

application/json application/xml

pnf-name

unique name of Physical Network Function.

path string
software-version-id

Identifier of the software version

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

returns route-table-references

GET /network/route-table-references

Tags: Network

returns route-table-references

route-table-reference-id query string
route-table-reference-fqdn query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns route-table-reference

GET /network/route-table-references/route-table-reference/{route-table-reference-id}

Tags: Network

returns route-table-reference

route-table-reference-id

Route Table Reference id, UUID assigned to this instance.

path string

application/json application/xml

200 OK

successful operation

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

Route Table Reference id, UUID assigned to this instance.

path string

application/json application/xml

default

Response codes found in response codes.

update an existing route-table-reference

PATCH /network/route-table-references/route-table-reference/{route-table-reference-id}

Tags: Network

update an existing route-table-reference

application/json application/xml

route-table-reference object that needs to be updated.

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.

route-table-reference-id

Route Table Reference id, UUID assigned to this instance.

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

route-table-reference-id

Route Table Reference id, UUID assigned to this instance.

path string

application/json application/xml

default

Response codes found in response codes.

returns sdwan-vpns

GET /network/sdwan-vpns

Tags: Network

returns sdwan-vpns

sdwan-vpn-id query string
sdwan-vpn-name query string
vxlan-id query string
topology query string
operational-status query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns sdwan-vpn

GET /network/sdwan-vpns/sdwan-vpn/{sdwan-vpn-id}

Tags: Network

returns sdwan-vpn

sdwan-vpn-id

Uniquely identifies this sdwan-vpn by id

path string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

create or update an existing sdwan-vpn

PUT /network/sdwan-vpns/sdwan-vpn/{sdwan-vpn-id}

Tags: Network

create or update an existing sdwan-vpn

application/json application/xml

sdwan-vpn object that needs to be created or updated.

sdwan-vpn-id

Uniquely identifies this sdwan-vpn by id

path string

application/json application/xml

default

Response codes found in response codes.

update an existing sdwan-vpn

PATCH /network/sdwan-vpns/sdwan-vpn/{sdwan-vpn-id}

Tags: Network

update an existing sdwan-vpn

application/json application/xml

sdwan-vpn object that needs to be updated.

sdwan-vpn-id

Uniquely identifies this sdwan-vpn by id

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing sdwan-vpn

DELETE /network/sdwan-vpns/sdwan-vpn/{sdwan-vpn-id}

Tags: Network

delete an existing sdwan-vpn

application/json application/xml

sdwan-vpn-id

Uniquely identifies this sdwan-vpn by id

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/sdwan-vpns/sdwan-vpn/{sdwan-vpn-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

sdwan-vpn-id

Uniquely identifies this sdwan-vpn by id

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/sdwan-vpns/sdwan-vpn/{sdwan-vpn-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

sdwan-vpn-id

Uniquely identifies this sdwan-vpn by id

path string

application/json application/xml

default

Response codes found in response codes.

returns site-pair-sets

GET /network/site-pair-sets

Tags: Network

returns site-pair-sets

site-pair-set-id query string

application/json application/xml

200 OK

successful operation

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

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

Unique id of site pair set.

path string

application/json application/xml

default

Response codes found in response codes.

update an existing site-pair-set

PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}

Tags: Network

update an existing site-pair-set

application/json application/xml

site-pair-set object that needs to be updated.

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.

site-pair-set-id

Unique id of site pair set.

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

site-pair-set-id

Unique id of site pair set.

path string

application/json application/xml

default

Response codes found in response codes.

returns routing-instances

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances

Tags: Network

returns routing-instances

site-pair-set-id

Unique id of site pair set.

path string
routing-instance-id query string

application/json application/xml

200 OK

successful operation

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

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.

site-pair-set-id

Unique id of site pair set.

path string
routing-instance-id

Unique id of routing instance

path string

application/json application/xml

default

Response codes found in response codes.

update an existing routing-instance

PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

Tags: Network

update an existing routing-instance

application/json application/xml

routing-instance object that needs to be updated.

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.

site-pair-set-id

Unique id of site pair set.

path string
routing-instance-id

Unique id of routing instance

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

site-pair-set-id

Unique id of site pair set.

path string
routing-instance-id

Unique id of routing instance

path string

application/json application/xml

default

Response codes found in response codes.

returns site-pairs

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs

Tags: Network

returns site-pairs

site-pair-set-id

Unique id of site pair set.

path string
routing-instance-id

Unique id of routing instance

path string
site-pair-id query string

application/json application/xml

200 OK

successful operation

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

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

Unique id of site pair set.

path string
routing-instance-id

Unique id of routing instance

path string
site-pair-id

unique identifier of probe

path string

application/json application/xml

default

Response codes found in response codes.

update an existing site-pair

PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}

Tags: Network

update an existing site-pair

application/json application/xml

site-pair object that needs to be updated.

site-pair-set-id

Unique id of site pair set.

path string
routing-instance-id

Unique id of routing instance

path string
site-pair-id

unique identifier of probe

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing site-pair

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}

Tags: Network

delete an existing site-pair

application/json application/xml

site-pair-set-id

Unique id of site pair set.

path string
routing-instance-id

Unique id of routing instance

path string
site-pair-id

unique identifier of probe

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

returns classes-of-service

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service

Tags: Network

returns classes-of-service

site-pair-set-id

Unique id of site pair set.

path string
routing-instance-id

Unique id of routing instance

path string
site-pair-id

unique identifier of probe

path string
cos query string

application/json application/xml

200 OK

successful operation

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

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.

site-pair-set-id

Unique id of site pair set.

path string
routing-instance-id

Unique id of routing instance

path string
site-pair-id

unique identifier of probe

path string
cos

unique identifier of probe

path string

application/json application/xml

default

Response codes found in response codes.

update an existing class-of-service

PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}

Tags: Network

update an existing class-of-service

application/json application/xml

class-of-service object that needs to be updated.

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.

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.

site-pair-set-id

Unique id of site pair set.

path string
routing-instance-id

Unique id of routing instance

path string
site-pair-id

unique identifier of probe

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

site-pair-set-id

Unique id of site pair set.

path string
routing-instance-id

Unique id of routing instance

path string
site-pair-id

unique identifier of probe

path string

application/json application/xml

default

Response codes found in response codes.

returns site-resources

GET /network/site-resources

Tags: Network

returns site-resources

site-resource-id query string
site-resource-name query string
type query string
role query string
generated-site-id query string
operational-status query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns site-resource

GET /network/site-resources/site-resource/{site-resource-id}

Tags: Network

returns site-resource

site-resource-id

Uniquely identifies this site-resource by id

path string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

create or update an existing site-resource

PUT /network/site-resources/site-resource/{site-resource-id}

Tags: Network

create or update an existing site-resource

application/json application/xml

site-resource object that needs to be created or updated.

site-resource-id

Uniquely identifies this site-resource by id

path string

application/json application/xml

default

Response codes found in response codes.

update an existing site-resource

PATCH /network/site-resources/site-resource/{site-resource-id}

Tags: Network

update an existing site-resource

application/json application/xml

site-resource object that needs to be updated.

site-resource-id

Uniquely identifies this site-resource by id

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing site-resource

DELETE /network/site-resources/site-resource/{site-resource-id}

Tags: Network

delete an existing site-resource

application/json application/xml

site-resource-id

Uniquely identifies this site-resource by id

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/site-resources/site-resource/{site-resource-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

site-resource-id

Uniquely identifies this site-resource by id

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/site-resources/site-resource/{site-resource-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

site-resource-id

Uniquely identifies this site-resource by id

path string

application/json application/xml

default

Response codes found in response codes.

returns vces

GET /network/vces

Tags: Network

returns vces

vnf-id query string
vnf-name query string
vnf-name2 query string
vnf-type query string
service-id query string
regional-resource-zone query string
prov-status query string
heat-stack-id query string
vpe-id query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns vce

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

Tags: Network

returns vce

vnf-id

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

path string

application/json application/xml

200 OK

successful operation

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.

vnf-id

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

path string

application/json application/xml

default

Response codes found in response codes.

update an existing vce

PATCH /network/vces/vce/{vnf-id}

Tags: Network

update an existing vce

application/json application/xml

vce object that needs to be updated.

vnf-id

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

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing vce

DELETE /network/vces/vce/{vnf-id}

Tags: Network

delete an existing vce

application/json application/xml

vnf-id

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

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

returns entitlements

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

Tags: Network

returns entitlements

vnf-id

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

path string
group-uuid query string
resource-uuid query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns entitlement

GET /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

Tags: Network

returns entitlement

vnf-id

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

path string
group-uuid

Unique ID for the entitlement group the resource comes from, should be uuid.

path string
resource-uuid

Unique ID of an entitlement resource.

path string

application/json application/xml

200 OK

successful operation

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.

vnf-id

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

path string
group-uuid

Unique ID for the entitlement group the resource comes from, should be uuid.

path string
resource-uuid

Unique ID of an entitlement resource.

path string

application/json application/xml

default

Response codes found in response codes.

update an existing entitlement

PATCH /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

Tags: Network

update an existing entitlement

application/json application/xml

entitlement object that needs to be updated.

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.

vnf-id

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

path string
group-uuid

Unique ID for the entitlement group the resource comes from, should be uuid.

path string
resource-uuid

Unique ID of an entitlement resource.

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

vnf-id

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

path string
group-uuid

Unique ID for the entitlement group the resource comes from, should be uuid.

path string
resource-uuid

Unique ID of an entitlement resource.

path string

application/json application/xml

default

Response codes found in response codes.

returns licenses

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

Tags: Network

returns licenses

vnf-id

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

path string
group-uuid query string
resource-uuid query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns license

GET /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

Tags: Network

returns license

vnf-id

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

path string
group-uuid

Unique ID for the license group the resource belongs to, should be uuid.

path string
resource-uuid

Unique ID of a license resource.

path string

application/json application/xml

200 OK

successful operation

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.

vnf-id

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

path string
group-uuid

Unique ID for the license group the resource belongs to, should be uuid.

path string
resource-uuid

Unique ID of a license resource.

path string

application/json application/xml

default

Response codes found in response codes.

update an existing license

PATCH /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

Tags: Network

update an existing license

application/json application/xml

license object that needs to be updated.

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.

vnf-id

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

path string
group-uuid

Unique ID for the license group the resource belongs to, should be uuid.

path string
resource-uuid

Unique ID of a license resource.

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

vnf-id

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

path string
group-uuid

Unique ID for the license group the resource belongs to, should be uuid.

path string
resource-uuid

Unique ID of a license resource.

path string

application/json application/xml

default

Response codes found in response codes.

returns port-groups

GET /network/vces/vce/{vnf-id}/port-groups

Tags: Network

returns port-groups

vnf-id

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

path string
interface-id query string
port-group-id query string
switch-name query string
heat-stack-id query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns port-group

GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

Tags: Network

returns port-group

vnf-id

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

path string
interface-id

Unique ID of the interface

path string

application/json application/xml

200 OK

successful operation

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.

vnf-id

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

path string
interface-id

Unique ID of the interface

path string

application/json application/xml

default

Response codes found in response codes.

update an existing port-group

PATCH /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

Tags: Network

update an existing port-group

application/json application/xml

port-group object that needs to be updated.

vnf-id

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

path string
interface-id

Unique ID of the interface

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing port-group

DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

Tags: Network

delete an existing port-group

application/json application/xml

vnf-id

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

path string
interface-id

Unique ID of the interface

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

returns cvlan-tags

GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags

Tags: Network

returns cvlan-tags

vnf-id

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

path string
interface-id

Unique ID of the interface

path string
cvlan-tag query integer

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns cvlan-tag-entry

GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

Tags: Network

returns cvlan-tag-entry

vnf-id

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

path string
interface-id

Unique ID of the interface

path string
cvlan-tag

See mis-na-virtualization-platform.yang

path integer

application/json application/xml

200 OK

successful operation

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.

vnf-id

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

path string
interface-id

Unique ID of the interface

path string
cvlan-tag

See mis-na-virtualization-platform.yang

path integer

application/json application/xml

default

Response codes found in response codes.

update an existing cvlan-tag-entry

PATCH /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

Tags: Network

update an existing cvlan-tag-entry

application/json application/xml

cvlan-tag-entry object that needs to be updated.

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.

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.

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.

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

GET /network/vlan-tags

Tags: Network

returns vlan-tags

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns vlan-tag

GET /network/vlan-tags/vlan-tag/{vlan-tag-id}

Tags: Network

returns vlan-tag

vlan-tag-id

Unique ID of the vlan-tag

path string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

create or update an existing vlan-tag

PUT /network/vlan-tags/vlan-tag/{vlan-tag-id}

Tags: Network

create or update an existing vlan-tag

application/json application/xml

vlan-tag object that needs to be created or updated.

vlan-tag-id

Unique ID of the vlan-tag

path string

application/json application/xml

default

Response codes found in response codes.

update an existing vlan-tag

PATCH /network/vlan-tags/vlan-tag/{vlan-tag-id}

Tags: Network

update an existing vlan-tag

application/json application/xml

vlan-tag object that needs to be updated.

vlan-tag-id

Unique ID of the vlan-tag

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing vlan-tag

DELETE /network/vlan-tags/vlan-tag/{vlan-tag-id}

Tags: Network

delete an existing vlan-tag

application/json application/xml

vlan-tag-id

Unique ID of the vlan-tag

path string
resource-version

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/vlan-tags/vlan-tag/{vlan-tag-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

vlan-tag-id

Unique ID of the vlan-tag

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vlan-tags/vlan-tag/{vlan-tag-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

vlan-tag-id

Unique ID of the vlan-tag

path string

application/json application/xml

default

Response codes found in response codes.

returns vnfcs

GET /network/vnfcs

Tags: Network

returns vnfcs

vnfc-name query string
nfc-naming-code query string
nfc-function query string
prov-status query string
ipaddress-v4-oam-vip query string
in-maint query boolean
is-closed-loop-disabled query boolean
group-notation query string
model-invariant-id query string
model-version-id query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns vnfc

GET /network/vnfcs/vnfc/{vnfc-name}

Tags: Network

returns vnfc

vnfc-name

Unique ID of vnfc.

path string

application/json application/xml

200 OK

successful operation

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

Unique ID of vnfc.

path string

application/json application/xml

default

Response codes found in response codes.

update an existing vnfc

PATCH /network/vnfcs/vnfc/{vnfc-name}

Tags: Network

update an existing vnfc

application/json application/xml

vnfc object that needs to be updated.

vnfc-name

Unique ID of vnfc.

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing vnfc

DELETE /network/vnfcs/vnfc/{vnfc-name}

Tags: Network

delete an existing vnfc

application/json application/xml

vnfc-name

Unique ID of vnfc.

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

returns cps

GET /network/vnfcs/vnfc/{vnfc-name}/cps

Tags: Network

returns cps

vnfc-name

Unique ID of vnfc.

path string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns cp

GET /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}

Tags: Network

returns cp

vnfc-name

Unique ID of vnfc.

path string
cp-instance-id

Unique ID of the connection point.

path string

application/json application/xml

200 OK

successful operation

/cp
default

Response codes found in response codes.

create or update an existing cp

PUT /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}

Tags: Network

create or update an existing cp

application/json application/xml

cp object that needs to be created or updated.

/cp
vnfc-name

Unique ID of vnfc.

path string
cp-instance-id

Unique ID of the connection point.

path string

application/json application/xml

default

Response codes found in response codes.

update an existing cp

PATCH /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}

Tags: Network

update an existing cp

application/json application/xml

cp object that needs to be updated.

/cp
vnfc-name

Unique ID of vnfc.

path string
cp-instance-id

Unique ID of the connection point.

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing cp

DELETE /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}

Tags: Network

delete an existing cp

application/json application/xml

vnfc-name

Unique ID of vnfc.

path string
cp-instance-id

Unique ID of the connection point.

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

returns l3-interface-ipv4-address-list

vnfc-name

Unique ID of vnfc.

path string
cp-instance-id

Unique ID of the connection point.

path string
l3-interface-ipv4-address

IP address

path string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

create or update an existing l3-interface-ipv4-address-list

PUT /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

create or update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be created or updated.

vnfc-name

Unique ID of vnfc.

path string
cp-instance-id

Unique ID of the connection point.

path string
l3-interface-ipv4-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

update an existing l3-interface-ipv4-address-list

PATCH /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

vnfc-name

Unique ID of vnfc.

path string
cp-instance-id

Unique ID of the connection point.

path string
l3-interface-ipv4-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing l3-interface-ipv4-address-list

DELETE /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

delete an existing l3-interface-ipv4-address-list

application/json application/xml

vnfc-name

Unique ID of vnfc.

path string
cp-instance-id

Unique ID of the connection point.

path string
l3-interface-ipv4-address

IP address

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

vnfc-name

Unique ID of vnfc.

path string
cp-instance-id

Unique ID of the connection point.

path string
l3-interface-ipv4-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

vnfc-name

Unique ID of vnfc.

path string
cp-instance-id

Unique ID of the connection point.

path string
l3-interface-ipv4-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

returns l3-interface-ipv6-address-list

vnfc-name

Unique ID of vnfc.

path string
cp-instance-id

Unique ID of the connection point.

path string
l3-interface-ipv6-address

IP address

path string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

create or update an existing l3-interface-ipv6-address-list

PUT /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

create or update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be created or updated.

vnfc-name

Unique ID of vnfc.

path string
cp-instance-id

Unique ID of the connection point.

path string
l3-interface-ipv6-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

update an existing l3-interface-ipv6-address-list

PATCH /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

vnfc-name

Unique ID of vnfc.

path string
cp-instance-id

Unique ID of the connection point.

path string
l3-interface-ipv6-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing l3-interface-ipv6-address-list

DELETE /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

delete an existing l3-interface-ipv6-address-list

application/json application/xml

vnfc-name

Unique ID of vnfc.

path string
cp-instance-id

Unique ID of the connection point.

path string
l3-interface-ipv6-address

IP address

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

vnfc-name

Unique ID of vnfc.

path string
cp-instance-id

Unique ID of the connection point.

path string
l3-interface-ipv6-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

vnfc-name

Unique ID of vnfc.

path string
cp-instance-id

Unique ID of the connection point.

path string
l3-interface-ipv6-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

vnfc-name

Unique ID of vnfc.

path string
cp-instance-id

Unique ID of the connection point.

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

vnfc-name

Unique ID of vnfc.

path string
cp-instance-id

Unique ID of the connection point.

path string

application/json application/xml

default

Response codes found in response codes.

returns l3-interface-ipv4-address-list

GET /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

returns l3-interface-ipv4-address-list

vnfc-name

Unique ID of vnfc.

path string
l3-interface-ipv4-address

IP address

path string

application/json application/xml

200 OK

successful operation

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.

vnfc-name

Unique ID of vnfc.

path string
l3-interface-ipv4-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

update an existing l3-interface-ipv4-address-list

PATCH /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

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.

vnfc-name

Unique ID of vnfc.

path string
l3-interface-ipv4-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

vnfc-name

Unique ID of vnfc.

path string
l3-interface-ipv4-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

returns l3-interface-ipv6-address-list

GET /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

returns l3-interface-ipv6-address-list

vnfc-name

Unique ID of vnfc.

path string
l3-interface-ipv6-address

IP address

path string

application/json application/xml

200 OK

successful operation

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.

vnfc-name

Unique ID of vnfc.

path string
l3-interface-ipv6-address

IP address

path string

application/json application/xml

default

Response codes found in response codes.

update an existing l3-interface-ipv6-address-list

PATCH /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

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.

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.

vnfc-name

Unique ID of vnfc.

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

vnfc-name

Unique ID of vnfc.

path string

application/json application/xml

default

Response codes found in response codes.

returns vpls-pes

GET /network/vpls-pes

Tags: Network

returns vpls-pes

equipment-name query string
prov-status query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns vpls-pe

GET /network/vpls-pes/vpls-pe/{equipment-name}

Tags: Network

returns vpls-pe

equipment-name path string

application/json application/xml

200 OK

successful operation

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.

equipment-name path string

application/json application/xml

default

Response codes found in response codes.

update an existing vpls-pe

PATCH /network/vpls-pes/vpls-pe/{equipment-name}

Tags: Network

update an existing vpls-pe

application/json application/xml

vpls-pe object that needs to be updated.

equipment-name path string

application/json application/xml

default

Response codes found in response codes.

delete an existing vpls-pe

DELETE /network/vpls-pes/vpls-pe/{equipment-name}

Tags: Network

delete an existing vpls-pe

application/json application/xml

equipment-name path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

returns lag-interfaces

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces

Tags: Network

returns lag-interfaces

equipment-name path string
interface-name query string
interface-id query string
interface-role query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns lag-interface

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

Tags: Network

returns lag-interface

equipment-name path string
interface-name

Name that identifies the link aggregate interface

path string

application/json application/xml

200 OK

successful operation

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.

equipment-name path string
interface-name

Name that identifies the link aggregate interface

path string

application/json application/xml

default

Response codes found in response codes.

update an existing lag-interface

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

Tags: Network

update an existing lag-interface

application/json application/xml

lag-interface object that needs to be updated.

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
interface-name query string
interface-id query string
macaddr query string
network-name query string

application/json application/xml

200 OK

successful operation

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing l-interface

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: Network

update an existing l-interface

application/json application/xml

l-interface object that needs to be updated.

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing l3-interface-ipv4-address-list

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

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.

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing l3-interface-ipv6-address-list

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

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.

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.

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
pci-id query string
vf-vlan-filter query string
vf-mac-filter query string
vf-vlan-strip query boolean
neutron-network-id query string

application/json application/xml

200 OK

successful operation

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing sriov-vf

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

update an existing sriov-vf

application/json application/xml

sriov-vf object that needs to be updated.

equipment-name path string
interface-name

Name that identifies the link aggregate interface

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

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
vlan-interface query string
vlan-id-inner query integer
vpn-key query string

application/json application/xml

200 OK

successful operation

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing vlan

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

update an existing vlan

application/json application/xml

vlan object that needs to be updated.

equipment-name path string
interface-name

Name that identifies the link aggregate interface

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing l3-interface-ipv4-address-list

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

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.

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing l3-interface-ipv6-address-list

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

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.

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.

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.

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
interface-name query string
prov-status query string
operational-status query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns p-interface

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

Tags: Network

returns p-interface

equipment-name path string
interface-name

Name that identifies the physical interface

path string

application/json application/xml

200 OK

successful operation

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.

equipment-name path string
interface-name

Name that identifies the physical interface

path string

application/json application/xml

default

Response codes found in response codes.

update an existing p-interface

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

Tags: Network

update an existing p-interface

application/json application/xml

p-interface object that needs to be updated.

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
interface-name query string
interface-id query string
macaddr query string
network-name query string

application/json application/xml

200 OK

successful operation

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing l-interface

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: Network

update an existing l-interface

application/json application/xml

l-interface object that needs to be updated.

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing l3-interface-ipv4-address-list

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

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.

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing l3-interface-ipv6-address-list

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

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.

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.

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
pci-id query string
vf-vlan-filter query string
vf-mac-filter query string
vf-vlan-strip query boolean
neutron-network-id query string

application/json application/xml

200 OK

successful operation

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing sriov-vf

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

update an existing sriov-vf

application/json application/xml

sriov-vf object that needs to be updated.

equipment-name path string
interface-name

Name that identifies the physical interface

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

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
vlan-interface query string
vlan-id-inner query integer
vpn-key query string

application/json application/xml

200 OK

successful operation

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing vlan

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

update an existing vlan

application/json application/xml

vlan object that needs to be updated.

equipment-name path string
interface-name

Name that identifies the physical interface

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing l3-interface-ipv4-address-list

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network

update an existing l3-interface-ipv4-address-list

application/json application/xml

l3-interface-ipv4-address-list object that needs to be updated.

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.

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

application/json application/xml

200 OK

successful operation

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.

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.

update an existing l3-interface-ipv6-address-list

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network

update an existing l3-interface-ipv6-address-list

application/json application/xml

l3-interface-ipv6-address-list object that needs to be updated.

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.

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.

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.

equipment-name path string
interface-name

Name that identifies the physical interface

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

equipment-name path string
interface-name

Name that identifies the physical interface

path string

application/json application/xml

default

Response codes found in response codes.

returns sriov-pfs

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs

Tags: Network

returns sriov-pfs

equipment-name path string
interface-name

Name that identifies the physical interface

path string
pf-pci-id query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns sriov-pf

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

Tags: Network

returns sriov-pf

equipment-name path string
interface-name

Name that identifies the physical interface

path string
pf-pci-id

Identifier for the sriov-pf

path string

application/json application/xml

200 OK

successful operation

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.

equipment-name path string
interface-name

Name that identifies the physical interface

path string
pf-pci-id

Identifier for the sriov-pf

path string

application/json application/xml

default

Response codes found in response codes.

update an existing sriov-pf

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

Tags: Network

update an existing sriov-pf

application/json application/xml

sriov-pf object that needs to be updated.

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.

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.

equipment-name path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

equipment-name path string

application/json application/xml

default

Response codes found in response codes.

returns vpn-bindings

GET /network/vpn-bindings

Tags: Network

returns vpn-bindings

vpn-id query string
vpn-name query string
vpn-type query string
access-provider-id query string
access-client-id query string
access-topology-id query string
src-access-node-id query string
src-access-ltp-id query string
dst-access-node-id query string
dst-access-ltp-id query string
operational-status query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns vpn-binding

GET /network/vpn-bindings/vpn-binding/{vpn-id}

Tags: Network

returns vpn-binding

vpn-id

VPN ID, globally unique within A&AI

path string

application/json application/xml

200 OK

successful operation

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

VPN ID, globally unique within A&AI

path string

application/json application/xml

default

Response codes found in response codes.

update an existing vpn-binding

PATCH /network/vpn-bindings/vpn-binding/{vpn-id}

Tags: Network

update an existing vpn-binding

application/json application/xml

vpn-binding object that needs to be updated.

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.

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

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns route-target

GET /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

Tags: Network

returns route-target

vpn-id

VPN ID, globally unique within A&AI

path string
global-route-target

Number used to identify an RT, globally unique in the network

path string
route-target-role

Role assigned to this route target

path string

application/json application/xml

200 OK

successful operation

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.

vpn-id

VPN ID, globally unique within A&AI

path string
global-route-target

Number used to identify an RT, globally unique in the network

path string
route-target-role

Role assigned to this route target

path string

application/json application/xml

default

Response codes found in response codes.

update an existing route-target

PATCH /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

Tags: Network

update an existing route-target

application/json application/xml

route-target object that needs to be updated.

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.

vpn-id

VPN ID, globally unique within A&AI

path string
global-route-target

Number used to identify an RT, globally unique in the network

path string
route-target-role

Role assigned to this route target

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

vpn-id

VPN ID, globally unique within A&AI

path string
global-route-target

Number used to identify an RT, globally unique in the network

path string
route-target-role

Role assigned to this route target

path string

application/json application/xml

default

Response codes found in response codes.

returns wan-port-configs

GET /network/wan-port-configs

Tags: Network

returns wan-port-configs

wan-port-config-id query string
wan-port-config-name query string
device-id query string
ip-address query string
ipv4-address query string
ipv6-address query string
port-type query string
port-number query string
device-port-id query string
wan-port-id query string
operational-status query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns wan-port-config

GET /network/wan-port-configs/wan-port-config/{wan-port-config-id}

Tags: Network

returns wan-port-config

wan-port-config-id

Uniquely identifies this wan-port-config by id

path string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

create or update an existing wan-port-config

PUT /network/wan-port-configs/wan-port-config/{wan-port-config-id}

Tags: Network

create or update an existing wan-port-config

application/json application/xml

wan-port-config object that needs to be created or updated.

wan-port-config-id

Uniquely identifies this wan-port-config by id

path string

application/json application/xml

default

Response codes found in response codes.

update an existing wan-port-config

PATCH /network/wan-port-configs/wan-port-config/{wan-port-config-id}

Tags: Network

update an existing wan-port-config

application/json application/xml

wan-port-config object that needs to be updated.

wan-port-config-id

Uniquely identifies this wan-port-config by id

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing wan-port-config

DELETE /network/wan-port-configs/wan-port-config/{wan-port-config-id}

Tags: Network

delete an existing wan-port-config

application/json application/xml

wan-port-config-id

Uniquely identifies this wan-port-config by id

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

see node definition for valid relationships

PUT /network/wan-port-configs/wan-port-config/{wan-port-config-id}/relationship-list/relationship

Tags: Network

see node definition for valid relationships

application/json application/xml

relationship object that needs to be created or updated.

wan-port-config-id

Uniquely identifies this wan-port-config by id

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /network/wan-port-configs/wan-port-config/{wan-port-config-id}/relationship-list/relationship

Tags: Network

delete an existing relationship

application/json application/xml

wan-port-config-id

Uniquely identifies this wan-port-config by id

path string

application/json application/xml

default

Response codes found in response codes.

returns zones

GET /network/zones

Tags: Network

returns zones

zone-id query string
design-type query string
zone-context query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns zone

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

Tags: Network

returns zone

zone-id

Code assigned by AIC to the zone

path string

application/json application/xml

200 OK

successful operation

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

Code assigned by AIC to the zone

path string

application/json application/xml

default

Response codes found in response codes.

update an existing zone

PATCH /network/zones/zone/{zone-id}

Tags: Network

update an existing zone

application/json application/xml

zone object that needs to be updated.

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.

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

model-invariant-id query string
model-type query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns model

GET /service-design-and-creation/models/model/{model-invariant-id}

Tags: ServiceDesignAndCreation

returns model

model-invariant-id

Unique identifier corresponding to the main definition of a model in ASDC

path string

application/json application/xml

200 OK

successful operation

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

Unique identifier corresponding to the main definition of a model in ASDC

path string

application/json application/xml

default

Response codes found in response codes.

update an existing model

PATCH /service-design-and-creation/models/model/{model-invariant-id}

Tags: ServiceDesignAndCreation

update an existing model

application/json application/xml

model object that needs to be updated.

model-invariant-id

Unique identifier corresponding to the main definition of a model in ASDC

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing model

DELETE /service-design-and-creation/models/model/{model-invariant-id}

Tags: ServiceDesignAndCreation

delete an existing model

application/json application/xml

model-invariant-id

Unique identifier corresponding to the main definition of a model in ASDC

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

returns model-vers

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers

Tags: ServiceDesignAndCreation

returns model-vers

model-invariant-id

Unique identifier corresponding to the main definition of a model in ASDC

path string
model-version-id query string
model-name query string
model-version query string
distribution-status query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns model-ver

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

Tags: ServiceDesignAndCreation

returns model-ver

model-invariant-id

Unique identifier corresponding to the main definition of a model in ASDC

path string
model-version-id

Unique identifier corresponding to one version of a model in ASDC

path string

application/json application/xml

200 OK

successful operation

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

Unique identifier corresponding to the main definition of a model in ASDC

path string
model-version-id

Unique identifier corresponding to one version of a model in ASDC

path string

application/json application/xml

default

Response codes found in response codes.

update an existing model-ver

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

Tags: ServiceDesignAndCreation

update an existing model-ver

application/json application/xml

model-ver object that needs to be updated.

model-invariant-id

Unique identifier corresponding to the main definition of a model in ASDC

path string
model-version-id

Unique identifier corresponding to one version of a model in ASDC

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing model-ver

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

Tags: ServiceDesignAndCreation

delete an existing model-ver

application/json application/xml

model-invariant-id

Unique identifier corresponding to the main definition of a model in ASDC

path string
model-version-id

Unique identifier corresponding to one version of a model in ASDC

path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

returns metadata

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata

Tags: ServiceDesignAndCreation

returns metadata

model-invariant-id

Unique identifier corresponding to the main definition of a model in ASDC

path string
model-version-id

Unique identifier corresponding to one version of a model in ASDC

path string
metaname query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns metadatum

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

Tags: ServiceDesignAndCreation

returns metadatum

model-invariant-id

Unique identifier corresponding to the main definition of a model in ASDC

path string
model-version-id

Unique identifier corresponding to one version of a model in ASDC

path string
metaname path string

application/json application/xml

200 OK

successful operation

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.

model-invariant-id

Unique identifier corresponding to the main definition of a model in ASDC

path string
model-version-id

Unique identifier corresponding to one version of a model in ASDC

path string
metaname path string

application/json application/xml

default

Response codes found in response codes.

update an existing metadatum

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

Tags: ServiceDesignAndCreation

update an existing metadatum

application/json application/xml

metadatum object that needs to be updated.

model-invariant-id

Unique identifier corresponding to the main definition of a model in ASDC

path string
model-version-id

Unique identifier corresponding to one version of a model in ASDC

path string
metaname path string

application/json application/xml

default

Response codes found in response codes.

delete an existing metadatum

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

Tags: ServiceDesignAndCreation

delete an existing metadatum

application/json application/xml

model-invariant-id

Unique identifier corresponding to the main definition of a model in ASDC

path string
model-version-id

Unique identifier corresponding to one version of a model in ASDC

path string
metaname path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

returns model-elements

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements

Tags: ServiceDesignAndCreation

returns model-elements

model-invariant-id

Unique identifier corresponding to the main definition of a model in ASDC

path string
model-version-id

Unique identifier corresponding to one version of a model in ASDC

path string
model-element-uuid query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns model-element

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}

Tags: ServiceDesignAndCreation

returns model-element

model-invariant-id

Unique identifier corresponding to the main definition of a model in ASDC

path string
model-version-id

Unique identifier corresponding to one version of a model in ASDC

path string
model-element-uuid path string

application/json application/xml

200 OK

successful operation

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

Unique identifier corresponding to the main definition of a model in ASDC

path string
model-version-id

Unique identifier corresponding to one version of a model in ASDC

path string
model-element-uuid path string

application/json application/xml

default

Response codes found in response codes.

update an existing model-element

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}

Tags: ServiceDesignAndCreation

update an existing model-element

application/json application/xml

model-element object that needs to be updated.

model-invariant-id

Unique identifier corresponding to the main definition of a model in ASDC

path string
model-version-id

Unique identifier corresponding to one version of a model in ASDC

path string
model-element-uuid path string

application/json application/xml

default

Response codes found in response codes.

delete an existing model-element

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}

Tags: ServiceDesignAndCreation

delete an existing model-element

application/json application/xml

model-invariant-id

Unique identifier corresponding to the main definition of a model in ASDC

path string
model-version-id

Unique identifier corresponding to one version of a model in ASDC

path string
model-element-uuid path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

returns model-constraints

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints

Tags: ServiceDesignAndCreation

returns model-constraints

model-invariant-id

Unique identifier corresponding to the main definition of a model in ASDC

path string
model-version-id

Unique identifier corresponding to one version of a model in ASDC

path string
model-element-uuid path string
model-constraint-uuid query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns model-constraint

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

Tags: ServiceDesignAndCreation

returns model-constraint

model-invariant-id

Unique identifier corresponding to the main definition of a model in ASDC

path string
model-version-id

Unique identifier corresponding to one version of a model in ASDC

path string
model-element-uuid path string
model-constraint-uuid path string

application/json application/xml

200 OK

successful operation

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

Unique identifier corresponding to the main definition of a model in ASDC

path string
model-version-id

Unique identifier corresponding to one version of a model in ASDC

path string
model-element-uuid path string
model-constraint-uuid path string

application/json application/xml

default

Response codes found in response codes.

update an existing model-constraint

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

Tags: ServiceDesignAndCreation

update an existing model-constraint

application/json application/xml

model-constraint object that needs to be updated.

model-invariant-id

Unique identifier corresponding to the main definition of a model in ASDC

path string
model-version-id

Unique identifier corresponding to one version of a model in ASDC

path string
model-element-uuid path string
model-constraint-uuid path string

application/json application/xml

default

Response codes found in response codes.

delete an existing model-constraint

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

Tags: ServiceDesignAndCreation

delete an existing model-constraint

application/json application/xml

model-invariant-id

Unique identifier corresponding to the main definition of a model in ASDC

path string
model-version-id

Unique identifier corresponding to one version of a model in ASDC

path string
model-element-uuid path string
model-constraint-uuid path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

returns constrained-element-sets

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets

Tags: ServiceDesignAndCreation

returns constrained-element-sets

model-invariant-id

Unique identifier corresponding to the main definition of a model in ASDC

path string
model-version-id

Unique identifier corresponding to one version of a model in ASDC

path string
model-element-uuid path string
model-constraint-uuid path string
constrained-element-set-uuid query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns constrained-element-set

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

Tags: ServiceDesignAndCreation

returns constrained-element-set

model-invariant-id

Unique identifier corresponding to the main definition of a model in ASDC

path string
model-version-id

Unique identifier corresponding to one version of a model in ASDC

path string
model-element-uuid path string
model-constraint-uuid path string
constrained-element-set-uuid path string

application/json application/xml

200 OK

successful operation

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.

model-invariant-id

Unique identifier corresponding to the main definition of a model in ASDC

path string
model-version-id

Unique identifier corresponding to one version of a model in ASDC

path string
model-element-uuid path string
model-constraint-uuid path string
constrained-element-set-uuid path string

application/json application/xml

default

Response codes found in response codes.

update an existing constrained-element-set

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

Tags: ServiceDesignAndCreation

update an existing constrained-element-set

application/json application/xml

constrained-element-set object that needs to be updated.

model-invariant-id

Unique identifier corresponding to the main definition of a model in ASDC

path string
model-version-id

Unique identifier corresponding to one version of a model in ASDC

path string
model-element-uuid path string
model-constraint-uuid path string
constrained-element-set-uuid path string

application/json application/xml

default

Response codes found in response codes.

delete an existing constrained-element-set

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

Tags: ServiceDesignAndCreation

delete an existing constrained-element-set

application/json application/xml

model-invariant-id

Unique identifier corresponding to the main definition of a model in ASDC

path string
model-version-id

Unique identifier corresponding to one version of a model in ASDC

path string
model-element-uuid path string
model-constraint-uuid path string
constrained-element-set-uuid path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

returns element-choice-sets

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets

Tags: ServiceDesignAndCreation

returns element-choice-sets

model-invariant-id

Unique identifier corresponding to the main definition of a model in ASDC

path string
model-version-id

Unique identifier corresponding to one version of a model in ASDC

path string
model-element-uuid path string
model-constraint-uuid path string
constrained-element-set-uuid path string
element-choice-set-uuid query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns element-choice-set

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

Tags: ServiceDesignAndCreation

returns element-choice-set

model-invariant-id

Unique identifier corresponding to the main definition of a model in ASDC

path string
model-version-id

Unique identifier corresponding to one version of a model in ASDC

path string
model-element-uuid path string
model-constraint-uuid path string
constrained-element-set-uuid path string
element-choice-set-uuid path string

application/json application/xml

200 OK

successful operation

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.

model-invariant-id

Unique identifier corresponding to the main definition of a model in ASDC

path string
model-version-id

Unique identifier corresponding to one version of a model in ASDC

path string
model-element-uuid path string
model-constraint-uuid path string
constrained-element-set-uuid path string
element-choice-set-uuid path string

application/json application/xml

default

Response codes found in response codes.

update an existing element-choice-set

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

Tags: ServiceDesignAndCreation

update an existing element-choice-set

application/json application/xml

element-choice-set object that needs to be updated.

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.

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.

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.

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.

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.

model-invariant-id

Unique identifier corresponding to the main definition of a model in ASDC

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship

Tags: ServiceDesignAndCreation

delete an existing relationship

application/json application/xml

model-invariant-id

Unique identifier corresponding to the main definition of a model in ASDC

path string

application/json application/xml

default

Response codes found in response codes.

returns named-queries

GET /service-design-and-creation/named-queries

Tags: ServiceDesignAndCreation

returns named-queries

named-query-uuid query string
named-query-name query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns named-query

GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}

Tags: ServiceDesignAndCreation

returns named-query

named-query-uuid path string

application/json application/xml

200 OK

successful operation

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-uuid path string

application/json application/xml

default

Response codes found in response codes.

update an existing named-query

PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}

Tags: ServiceDesignAndCreation

update an existing named-query

application/json application/xml

named-query object that needs to be updated.

named-query-uuid path string

application/json application/xml

default

Response codes found in response codes.

delete an existing named-query

DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}

Tags: ServiceDesignAndCreation

delete an existing named-query

application/json application/xml

named-query-uuid path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

returns named-query-elements

GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements

Tags: ServiceDesignAndCreation

returns named-query-elements

named-query-uuid path string
named-query-element-uuid query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns named-query-element

GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}

Tags: ServiceDesignAndCreation

returns named-query-element

named-query-uuid path string
named-query-element-uuid path string

application/json application/xml

200 OK

successful operation

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-uuid path string
named-query-element-uuid path string

application/json application/xml

default

Response codes found in response codes.

update an existing named-query-element

PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}

Tags: ServiceDesignAndCreation

update an existing named-query-element

application/json application/xml

named-query-element object that needs to be updated.

named-query-uuid path string
named-query-element-uuid path string

application/json application/xml

default

Response codes found in response codes.

delete an existing named-query-element

DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}

Tags: ServiceDesignAndCreation

delete an existing named-query-element

application/json application/xml

named-query-uuid path string
named-query-element-uuid path string
resource-version

resource-version for concurrency

query string

application/json application/xml

default

Response codes found in response codes.

returns property-constraints

GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints

Tags: ServiceDesignAndCreation

returns property-constraints

named-query-uuid path string
named-query-element-uuid path string
property-constraint-uuid query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns property-constraint

GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}

Tags: ServiceDesignAndCreation

returns property-constraint

named-query-uuid path string
named-query-element-uuid path string
property-constraint-uuid path string

application/json application/xml

200 OK

successful operation

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.

named-query-uuid path string
named-query-element-uuid path string
property-constraint-uuid path string

application/json application/xml

default

Response codes found in response codes.

update an existing property-constraint

PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}

Tags: ServiceDesignAndCreation

update an existing property-constraint

application/json application/xml

property-constraint object that needs to be updated.

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.

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.

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.

named-query-uuid path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship

Tags: ServiceDesignAndCreation

delete an existing relationship

application/json application/xml

named-query-uuid path string

application/json application/xml

default

Response codes found in response codes.

returns service-capabilities

GET /service-design-and-creation/service-capabilities

Tags: ServiceDesignAndCreation

returns service-capabilities

service-type query string
vnf-type query string

application/json application/xml

200 OK

successful operation

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

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

update an existing service-capability

PATCH /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

Tags: ServiceDesignAndCreation

update an existing service-capability

application/json application/xml

service-capability object that needs to be updated.

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.

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

service-id query string
service-description query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns service

GET /service-design-and-creation/services/service/{service-id}

Tags: ServiceDesignAndCreation

returns service

service-id

This gets defined by others to provide a unique ID for the service, we accept what is sent.

path string

application/json application/xml

200 OK

successful operation

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

This gets defined by others to provide a unique ID for the service, we accept what is sent.

path string

application/json application/xml

default

Response codes found in response codes.

update an existing service

PATCH /service-design-and-creation/services/service/{service-id}

Tags: ServiceDesignAndCreation

update an existing service

application/json application/xml

service object that needs to be updated.

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.

service-id

This gets defined by others to provide a unique ID for the service, we accept what is sent.

path string

application/json application/xml

default

Response codes found in response codes.

delete an existing relationship

DELETE /service-design-and-creation/services/service/{service-id}/relationship-list/relationship

Tags: ServiceDesignAndCreation

delete an existing relationship

application/json application/xml

service-id

This gets defined by others to provide a unique ID for the service, we accept what is sent.

path string

application/json application/xml

default

Response codes found in response codes.

returns vnf-images

GET /service-design-and-creation/vnf-images

Tags: ServiceDesignAndCreation

returns vnf-images

vnf-image-uuid query string
application query string
application-vendor query string
application-version query string

application/json application/xml

200 OK

successful operation

default

Response codes found in response codes.

returns vnf-image

GET /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

Tags: ServiceDesignAndCreation

returns vnf-image

vnf-image-uuid

Unique ID of this asset

path string

application/json application/xml

200 OK

successful operation

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

Unique ID of this asset

path string

application/json application/xml

default

Response codes found in response codes.

update an existing vnf-image

PATCH /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

Tags: ServiceDesignAndCreation

update an existing vnf-image

application/json application/xml

vnf-image object that needs to be updated.

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.

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

property-name: string
property-value: string

actions: object

APIs that are more action related than REST (e.g., notify, update).

update: object
notify: object

allotted-resource: object

Represents a slice or partial piece of a resource that gets separately allotted

  • TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
  • TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
  • TO l-interface( allotted-resource Uses l-interface, ONE2MANY)
  • TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
  • TO network-policy( allotted-resource Uses network-policy, ONE2ONE)
  • TO service-instance (PARENT of allotted-resource, allotted-resource BelongsTo service-instance, MANY2ONE)(4)
  • TO vlan( allotted-resource PartOf vlan, MANY2MANY)
  • TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY)
  • FROM configuration( configuration Uses allotted-resource, ONE2ONE)(3)
  • FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
  • FROM site-resource( site-resource Uses allotted-resource, MANY2MANY)
  • For CCVPN Usecase

  • FROM tunnel-xconnect (CHILD of allotted-resource, tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
  • (1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
  • (3) IF this FROM node is deleted, this ALLOTTED-RESOURCE is DELETED also
  • (4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
id: string

Allotted Resource id UUID assigned to this instance.

description: string

The descriptive information assigned to this allotted resource instance

selflink: string

Link back to more information in the controller

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

resource-version: string

Concurrency value

orchestration-status: string

Orchestration status

operational-status: string

Indicator for whether the resource is considered operational

type: string

Generic description of the type of allotted resource.

role: string

role in the network that this resource will be providing.

allotted-resource-name: string

Store the name of this allotted-resource.

access-provider-id: string

Store the id of the access provider of this allotted-resource.

access-client-id: string

Store the id of the access client of this allotted-resource.

access-topology-id: string

Store the id of the access topology of this allotted-resource.

access-node-id: string

Store the id of the access node of this allotted-resource.

access-ltp-id: string

Store the id of the access ltp of this allotted-resource.

cvlan: string

Store the cvlan of this allotted-resource.

vpn-name: string

Store the vpn-name of this allotted-resource.

tunnel-xconnects: object[]
relationship-list: object[]

allotted-resources: object

This object is used to store slices of services being offered

allotted-resource: object[]

availability-zone: object

Availability zone, a collection of compute hosts/pservers

  • TO cloud-region (PARENT of availability-zone, availability-zone BelongsTo cloud-region, MANY2ONE)(4)
  • TO complex( availability-zone LocatedIn complex, MANY2ONE)
  • TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
  • FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
  • FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
  • FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
  • FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
  • FROM vce( vce Uses availability-zone, MANY2MANY)
  • (4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
  • AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
availability-zone-name: string

Name of the availability zone. Unique across a cloud region

hypervisor-type: string

Type of hypervisor. Source of truth should define valid values.

operational-status: string

State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]

availability-zones: object

Collection of availability zones

availability-zone: object[]

az-and-dvs-switches: object

dvs-switches: object
availability-zone: object

business: object

Namespace for business related constructs

connectors: object[]
customers: object[]
lines-of-business: object[]
owning-entities: object[]
platforms: object[]
projects: object[]
sp-partners: object[]

class-of-service: object

  • TO site-pair (PARENT of class-of-service, class-of-service BelongsTo site-pair, MANY2ONE)(4)
  • (4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
cos: string

unique identifier of probe

probe-id: string

identifier of probe

probe-type: string

type of probe

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]

classes-of-service: object

class-of-service of probe

class-of-service: object[]

cloud-infrastructure: object

Namespace for cloud infrastructure.

complexes: object[]
cloud-regions: object[]
network-profiles: object[]
pservers: object[]
virtual-data-centers: object[]
operational-environments: object[]
network-technologies: object[]

cloud-region: object

cloud-region designates an installation of a cloud cluster or region or instantiation. In AT&Ts AIC cloud, this could be an LCP or DCP. Cloud regions are uniquely identified by a composite key, cloud-owner + cloud-region-id. The format of the cloud-owner is vendor-cloudname and we will use att-aic for AT&T's AIC.

  • TO complex( cloud-region LocatedIn complex, MANY2ONE)
  • TO instance-group( cloud-region Uses instance-group, ONE2MANY)
  • TO l3-network( cloud-region Uses l3-network, MANY2MANY)
  • TO network-technology( cloud-region Uses network-technology, MANY2MANY)
  • TO zone( cloud-region LocatedIn zone, MANY2ONE)
  • FROM availability-zone (CHILD of cloud-region, availability-zone BelongsTo cloud-region, MANY2ONE)(1)
  • FROM dvs-switch (CHILD of cloud-region, dvs-switch BelongsTo cloud-region, MANY2ONE)
  • FROM esr-system-info (CHILD of cloud-region, esr-system-info BelongsTo cloud-region, MANY2ONE)(1)
  • FROM flavor (CHILD of cloud-region, flavor BelongsTo cloud-region, MANY2ONE)
  • FROM group-assignment (CHILD of cloud-region, group-assignment BelongsTo cloud-region, MANY2ONE)
  • FROM hpa-capability (CHILD of cloud-region, hpa-capability BelongsTo cloud-region, MANY2ONE)
  • FROM image (CHILD of cloud-region, image BelongsTo cloud-region, MANY2ONE)
  • FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
  • FROM oam-network (CHILD of cloud-region, oam-network BelongsTo cloud-region, MANY2ONE)
  • FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
  • FROM snapshot (CHILD of cloud-region, snapshot BelongsTo cloud-region, MANY2ONE)
  • FROM tenant (CHILD of cloud-region, tenant BelongsTo cloud-region, MANY2ONE)
  • FROM vip-ipv4-address-list (CHILD of cloud-region, vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
  • FROM vip-ipv6-address-list (CHILD of cloud-region, vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
  • FROM vlan-tag( vlan-tag BelongsTo cloud-region, MANY2ONE)
  • FROM volume-group (CHILD of cloud-region, volume-group BelongsTo cloud-region, MANY2ONE)
  • (1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
  • CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,HPA-CAPABILITY,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
cloud-owner: string

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

cloud-region-id: string

Identifier used by the vendor for the region. Second part of composite key

cloud-type: string

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

owner-defined-type: string

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

cloud-region-version: string

Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.

identity-url: string

URL of the keystone identity service

cloud-zone: string

Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.

complex-name: string

complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.

sriov-automation: string

Whether the cloud region supports (true) or does not support (false) SR-IOV automation.

cloud-extra-info: string

ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

volume-groups: object[]
tenants: object[]
flavors: object[]
group-assignments: object[]
snapshots: object[]
images: object[]
dvs-switches: object[]
oam-networks: object[]
availability-zones: object[]
relationship-list: object[]
vip-ipv4-address-list: object[]
vip-ipv6-address-list: object[]
hpa-capabilities: object[]
esr-system-info-list: object[]

cloud-regions: object

cloud-region: object[]

collection: object

represents the collection resource in the TOSCA model

  • FROM instance-group( instance-group BelongsTo collection, ONE2ONE)
  • FROM service-instance( service-instance ComposedOf collection, ONE2ONE)
collection-id: string

Collection Object UUID

model-invariant-id: string

ASDC model id for this resource or service model

model-version-id: string

Model Version

collection-name: string

collection name

collection-type: string

Collection type

collection-role: string

Collection Role

collection-function: string

Collection function

orchestration-status: string

orchestration status

collection-customization-id: string

Captures the id of all the configuration used to customize the resource for the service

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]

collections: object

collection: object[]

complex: object

Collection of physical locations that can house cloud-regions.

  • TO l3-network( complex Uses l3-network, MANY2MANY)
  • FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
  • FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
  • FROM ctag-pool (CHILD of complex, ctag-pool BelongsTo complex, MANY2ONE)(1)
  • FROM generic-vnf( generic-vnf LocatedIn complex, MANY2MANY)
  • FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
  • FROM pnf( pnf LocatedIn complex, MANY2ONE)
  • FROM pserver( pserver LocatedIn complex, MANY2ONE)
  • FROM site-resource( site-resource Uses complex, MANY2MANY)
  • For CCVPN Usecase

  • FROM vce( vce LocatedIn complex, MANY2MANY)
  • FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
  • FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
  • FROM zone( zone LocatedIn complex, MANY2ONE)
  • (1) IF this COMPLEX node is deleted, this FROM node is DELETED also
  • COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
physical-location-id: string

Unique identifier for physical location, e.g., CLLI

data-center-code: string

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

complex-name: string

Gamma complex name for LCP instance.

identity-url: string

URL of the keystone identity service

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

physical-location-type: string

Type, e.g., central office, data center.

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[]
relationship-list: object[]

complexes: object

Collection of physical locations that can house cloud-regions.

complex: object[]

configuration: object

Generic configuration object.

  • TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
  • TO configuration( configuration BindsTo configuration, ONE2ONE)
  • TO l-interface( configuration AppliesTo l-interface, ONE2MANY)
  • TO l3-network( configuration PartOf l3-network, ONE2ONE)
  • TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
  • TO pnf( configuration AppliesTo pnf, MANY2MANY)
  • TO vnfc( configuration Uses vnfc, ONE2ONE)(4)
  • TO vpn-binding( configuration Uses vpn-binding, MANY2ONE)
  • FROM configuration( configuration BindsTo configuration, ONE2ONE)
  • FROM evc (CHILD of configuration, evc BelongsTo configuration, ONE2ONE)(1)
  • FROM forwarder( forwarder Uses configuration, ONE2ONE)(3)
  • FROM forwarder-evc (CHILD of configuration, forwarder-evc BelongsTo configuration, ONE2ONE)(1)
  • FROM forwarding-path( forwarding-path Uses configuration, ONE2ONE)(3)
  • FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
  • FROM metadatum (CHILD of configuration, metadatum BelongsTo configuration, MANY2ONE)(1)
  • FROM service-instance( service-instance Uses configuration, ONE2MANY)
  • FROM service-instance( service-instance ComposedOf configuration, MANY2MANY)
  • (1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
  • (2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
  • (3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
  • (4) IF this TO node is deleted, this CONFIGURATION is DELETED also
configuration-id: string

UUID assigned to configuration.

management-option: string

Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.

configuration-name: string

Name of the configuration.

configuration-type: string

port-mirroring-configuration.

configuration-sub-type: string

vprobe, pprobe.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

orchestration-status: string

Orchestration status of the configuration.

operational-status: string

Indicator for whether the resource is considered operational.

configuration-selflink: string

URL to endpoint where AAI can get more details from SDN-GC.

model-customization-id: string

id of the configuration used to customize the resource

tunnel-bandwidth: string

DHV Site Effective Bandwidth

vendor-allowed-max-bandwidth: string

Velocloud Nominal Throughput - VNT

config-policy-name: string

Used to capture the name of the fabric configuration policy that was used to generate the payload sent to PINC for fabric configuration.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]
metadata: object[]
forwarder-evcs: object[]
evcs: object[]
evc

configurations: object

Collection of configurations

configuration: object[]

connectivities: object

Collection of connectivities

connectivity: object[]

connectivity: object

Instance of a connectivity

  • TO ext-aai-network( connectivity BelongsTo ext-aai-network, MANY2MANY)
  • For CCVPN Usecase(2)

  • TO service-instance( connectivity PartOf service-instance, ONE2MANY)
  • For CCVPN Usecase

  • TO vpn-binding( connectivity PartOf vpn-binding, ONE2MANY)
  • For CCVPN Usecase

  • (2) IF this CONNECTIVITY node is deleted, this TO node is DELETED also
connectivity-id: string

Uniquely identifies this connectivity by id

bandwidth-profile-name: string

Store the name of a bandwidth profile.

vpn-type: string

Store the type of a bandwidth profile.

cir: string

Store the CIR of this connectivity.

eir: string

Store the EIR of this connectivity.

cbs: string

Store the CBS of this connectivity.

ebs: string

Store the EBS of this connectivity.

color-aware: string

Store the color-awareness of this connectivity.

coupling-flag: string

Store the coupling flag of this connectivity.

etht-svc-name: string

The ethernet service name for this connectivity.

access-provider-id: string

Store the id of the access provider of this connectivity.

access-client-id: string

Store the id of the access client of this connectivity.

access-topology-id: string

Store the id of the access topology of this connectivity.

access-node-id: string

Store the id of the access node of this connectivity.

access-ltp-id: string

Store the id of the access ltp of this connectivity.

connectivity-selflink: string

Store the link to get more information for this connectivity.

cvlan: string

Store the cvlan for this connectivity.

operational-status: string

Store the operational-status for this object.

model-customization-id: string

Store the model-customization-id for this object.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]

connector: object

Collection of resource instances used to connect a variety of disparate inventory widgets

  • TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
  • FROM metadatum (CHILD of connector, metadatum BelongsTo connector, MANY2ONE)(1)
  • FROM service-instance( service-instance Uses connector, MANY2MANY)
  • (1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
resource-instance-id: string

Unique id of resource instance.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

widget-model-id: string

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

widget-model-version: string

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

relationship-list: object[]
metadata: object[]

connectors: object

Collection of resource instances used to connect a variety of disparate inventory widgets

connector: object[]

constrained-element-set: object

This is how we would capture constraints defining allowed sets of elements.

  • TO model-constraint (PARENT of constrained-element-set, constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
  • TO model-element (PARENT of constrained-element-set, constrained-element-set BelongsTo model-element, MANY2ONE)(4)
  • FROM element-choice-set (CHILD of constrained-element-set, element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
  • (1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
constrained-element-set-uuid: string
constraint-type: string
check-type: string
resource-version: string
element-choice-sets: object[]
relationship-list: object[]

constrained-element-sets: object

constrained-element-set: object[]

cp: object

point of attachment from services or resources to a virtual link or network.

  • FROM l-interface( l-interface LinksTo cp, ONE2ONE)
  • FROM l3-interface-ipv4-address-list (CHILD of cp, l3-interface-ipv4-address-list BelongsTo cp, MANY2ONE)(1)
  • FROM l3-interface-ipv6-address-list (CHILD of cp, l3-interface-ipv6-address-list BelongsTo cp, MANY2ONE)(1)
  • FROM l3-network( l3-network LinksTo cp, MANY2MANY)
  • FROM vip-ipv4-address-list( vip-ipv4-address-list Uses cp, MANY2MANY)
  • FROM vip-ipv6-address-list( vip-ipv6-address-list Uses cp, MANY2MANY)
  • FROM vlan-tag( vlan-tag Uses cp, MANY2MANY)
  • FROM vnfc (PARENT of cp, vnfc BelongsTo cp, ONE2MANY)
  • cp is child of vnfc(3)

  • (1) IF this CP node is deleted, this FROM node is DELETED also
  • (3) IF this FROM node is deleted, this CP is DELETED also
cp-instance-id: string

Unique ID of the connection point.

port-id: integer

port index to represent multiple CPs on VNFC connected to same network.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]
l3-interface-ipv4-address-list: object[]
l3-interface-ipv6-address-list: object[]

cps: object

Collection of connection points.

cp: object[]
cp

ctag-assignment: object

  • TO l3-network (PARENT of ctag-assignment, ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
  • FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)
  • (4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
vlan-id-inner: integer

id.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]

ctag-assignments: object

ctag-assignment: object[]

ctag-pool: object

A collection of C tags (vlan tags) grouped for a specific purpose.

  • TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
  • TO complex (PARENT of ctag-pool, ctag-pool BelongsTo complex, MANY2ONE)(4)
  • FROM generic-vnf( generic-vnf Uses ctag-pool, MANY2MANY)
  • FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
  • (4) IF this TO node is deleted, this CTAG-POOL is DELETED also
target-pe: string

The Target provider edge router

availability-zone-name: string

Name of the availability zone

ctag-pool-purpose: string

Describes what the intended purpose of this pool is.

ctag-values: string

Comma separated list of ctags

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]

ctag-pools: object

ctag-pool: object[]

customer: object

customer identifiers to provide linkage back to BSS information.

  • FROM service-subscription (CHILD of customer, service-subscription BelongsTo customer, MANY2ONE)(1)
  • FROM vpn-binding( vpn-binding Uses customer, MANY2MANY)
  • (1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
global-customer-id: string

Global customer id used across 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[]
relationship-list: object[]

customers: object

Collection of customer identifiers to provide linkage back to BSS information.

customer: object[]

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

cvlan-tags: object

cvlan-tag-entry: object[]

device: object

Instance of a device

  • TO ext-aai-network( device BelongsTo ext-aai-network, MANY2MANY)
  • For CCVPN Usecase(2)

  • TO generic-vnf( device Uses generic-vnf, ONE2MANY)
  • For CCVPN Usecase

  • TO service-instance( device PartOf service-instance, ONE2MANY)
  • For CCVPN Usecase

  • (2) IF this DEVICE node is deleted, this TO node is DELETED also
device-id: string

Uniquely identifies this device by id

esn: string

Store the esn of this device.

device-name: string

Store the name of this device.

description: string

Store the description of this device.

vendor: string

Store the vendor of this device.

class: string

Store the class of this device.

type: string

Store the type of this device.

version: string

Store the version of this device.

system-ip: string

Store the system-ip of this device.

system-ipv4: string

Store the system-ipv4 of this device.

system-ipv6: string

Store the system-ipv6 of this device.

selflink: string

Store the link to get more information for this object.

operational-status: string

Store the operational-status for this object.

model-customization-id: string

Store the model-customization-id for this object.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]

devices: object

Collection of devices

device: object[]

dhcp-service: object

Instance of a dhcp-service

  • FROM lan-port-config (PARENT of dhcp-service, lan-port-config Uses dhcp-service, ONE2MANY)
  • For CCVPN Usecase(3)

  • (3) IF this FROM node is deleted, this DHCP-SERVICE is DELETED also
  • DHCP-SERVICE cannot be deleted if related to LAN-PORT-CONFIG
dhcp-service-id: string

Uniquely identifies this dhcp-service by id

server-ipv4-address: string

Store the server-ip4-address of this dhcp-service.

server-ipv6-address: string

Store the server-ipv6-address of this dhcp-service.

service-enable: string

Store the service-enable of this dhcp-service.

dhcp-service-type: string

Store the dhcp-service-type of this dhcp-service.

lease-time: string

Store the lease-time of this dhcp-service.

domain-name: string

Store the domain-name of this dhcp-service.

dns: string

Store the dns of this dhcp-service.

ntp-primary: string

Store the ntp-primary of this dhcp-service.

ntp-secondary: string

Store the ntp-secondary of this dhcp-service.

nbns: string

Store the nbns of this dhcp-service.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]

dhcp-services: object

Collection of dhcp-services

dhcp-service: object[]

dvs-switch: object

Digital virtual switch metadata, used by SDN-C to configure VCEs. A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI.

  • TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
  • TO cloud-region (PARENT of dvs-switch, dvs-switch BelongsTo cloud-region, MANY2ONE)
switch-name: string

DVS switch name

vcenter-url: string

URL used to reach the vcenter

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]

dvs-switches: object

Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.

dvs-switch: object[]

edge-prop-names: object

Internal map to define the properties of an edge and interpret the map EdgeRules

edgeLabel: string
direction: string
multiplicityRule: string
contains-other-v: string
delete-other-v: string
SVC-INFRA: string
prevent-delete: string
aai-uuid: string

edge-tag-query-request: object

edge-tag: string
result-detail: string
start-node-type: string
start-node-filter: object[]
include-node-filter: object[]
secondary-filter: object[]

edge-tag-query-result: object

tagged-inventory-item-list: object[]

element-choice-set: object

This is how we would capture constraints defining allowed sets of elements.

  • TO constrained-element-set (PARENT of element-choice-set, element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
  • FROM model-element (CHILD of element-choice-set, model-element BelongsTo element-choice-set, MANY2ONE)(1)
  • (1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
element-choice-set-uuid: string
element-choice-set-name: string
cardinality: string
resource-version: string
model-elements: object[]
relationship-list: object[]

element-choice-sets: object

element-choice-set: object[]

entitlement: object

Metadata for entitlement group.

  • TO generic-vnf (PARENT of entitlement, entitlement BelongsTo generic-vnf, MANY2ONE)(4)
  • TO vce (PARENT of entitlement, entitlement BelongsTo vce, MANY2ONE)(4)
  • (4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
group-uuid: string

Unique ID for the entitlement group the resource comes from, should be uuid.

resource-uuid: string

Unique ID of an entitlement resource.

resource-version: string

Concurrency value

relationship-list: object[]

entitlements: object

Entitlements, keyed by group-uuid and resource-uuid, related to license management

entitlement: object[]

esr-ems: object

Persist EMS address information used by EMS driver.

  • FROM esr-system-info (CHILD of esr-ems, esr-system-info BelongsTo esr-ems, MANY2ONE)(1)
  • (1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
ems-id: string

Unique ID of EMS.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

esr-system-info-list: object
relationship-list: object

esr-ems-list: object

esr-ems: object[]

esr-system-info: object

Persist common address information of external systems.

  • TO cloud-region (PARENT of esr-system-info, esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
  • TO esr-ems (PARENT of esr-system-info, esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
  • TO esr-thirdparty-sdnc (PARENT of esr-system-info, esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
  • TO esr-vnfm (PARENT of esr-system-info, esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
  • FROM ext-aai-network (PARENT of esr-system-info, ext-aai-network Uses esr-system-info, ONE2MANY)
  • For CCVPN Usecase(3)

  • (3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also
  • (4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
  • ESR-SYSTEM-INFO cannot be deleted if related to EXT-AAI-NETWORK
esr-system-info-id: string

Unique ID of esr system info.

system-name: string

name of external system.

type: string

type of external systems.

vendor: string

vendor of external systems.

version: string

version of external systems.

service-url: string

url used to access external systems.

user-name: string

username used to access external systems.

password: string

password used to access external systems.

system-type: string

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

protocol: string

protocol of third party SDNC, for example netconf/snmp.

ssl-cacert: string

ca file content if enabled ssl on auth-url.

ssl-insecure: boolean

Whether to verify VIM's certificate.

ip-address: string

service IP of ftp server.

port: string

service port of ftp server.

cloud-domain: string

domain info for authentication.

default-tenant: string

default tenant of VIM.

passive: boolean

ftp passive mode or not.

remote-path: string

resource or performance data file path.

system-status: string

the status of external system.

openstack-region-id: string

OpenStack region ID used by MultiCloud plugin to interact with an OpenStack instance.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]

esr-system-info-list: object

Collection of persistent block-level external system auth info.

esr-system-info: object[]

esr-thirdparty-sdnc: object

Persist SDNC address information used by ONAP SDNC.

  • TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
  • FROM esr-system-info (CHILD of esr-thirdparty-sdnc, esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)
  • (1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
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
relationship-list: object

esr-thirdparty-sdnc-list: object

esr-thirdparty-sdnc: object[]

esr-vnfm: object

Persist VNFM address information used by VF-C.

  • FROM esr-system-info (CHILD of esr-vnfm, esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
  • (1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
vnfm-id: string

Unique ID of VNFM.

vim-id: string

indecate the VIM to deploy VNF.

certificate-url: string

certificate url of VNFM.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

esr-system-info-list: object
relationship-list: object

esr-vnfm-list: object

esr-vnfm: object[]

evc: object

evc object is an optional child object of the Configuration object.

  • TO configuration (PARENT of evc, evc BelongsTo configuration, ONE2ONE)(4)
  • (4) IF this TO node is deleted, this EVC is DELETED also
evc-id: string

Unique/key field for the evc object

forwarding-path-topology: string

Point-to-Point, Multi-Point

cir-value: string

Commited Information Rate

cir-units: string

CIR units

connection-diversity-group-id: string

Diversity Group ID

service-hours: string

formerly Performance Group

esp-evc-circuit-id: string

EVC Circuit ID of ESP EVC

esp-evc-cir-value: string

Committed Information Rate (For ESP)

esp-evc-cir-units: string

CIR units (For ESP)

esp-itu-code: string

Identifies ESP

collector-pop-clli: string

Collector POP CLLI (from the hostname of the access pnf)

inter-connect-type-ingress: string

Interconnect type on ingress side of EVC.

tagmode-access-ingress: string

tagode for collector side of EVC

tagmode-access-egress: string

tagMode for network side of EVC

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]

evcs: object

evc: object[]
evc

ext-aai-network: object

Refer to an external AAI in another ONAP.

  • TO esr-system-info (PARENT of ext-aai-network, ext-aai-network Uses esr-system-info, ONE2MANY)
  • For CCVPN Usecase(2)

  • FROM connectivity( connectivity BelongsTo ext-aai-network, MANY2MANY)
  • For CCVPN Usecase(3)

  • FROM device( device BelongsTo ext-aai-network, MANY2MANY)
  • For CCVPN Usecase(3)

  • FROM lan-port-config( lan-port-config BelongsTo ext-aai-network, MANY2MANY)
  • For CCVPN Usecase(3)

  • FROM logical-link( logical-link BelongsTo ext-aai-network, MANY2MANY)
  • For CCVPN Usecase(3)

  • FROM network-resource( network-resource BelongsTo ext-aai-network, MANY2MANY)
  • For CCVPN Usecase(3)

  • FROM pnf( pnf BelongsTo ext-aai-network, MANY2MANY)
  • For CCVPN Usecase(3)

  • FROM sdwan-vpn( sdwan-vpn BelongsTo ext-aai-network, MANY2MANY)
  • For CCVPN Usecase(3)

  • FROM site-resource( site-resource BelongsTo ext-aai-network, MANY2MANY)
  • For CCVPN Usecase(3)

  • FROM vpn-binding( vpn-binding BelongsTo ext-aai-network, MANY2MANY)
  • For CCVPN Usecase(3)

  • FROM wan-port-config( wan-port-config BelongsTo ext-aai-network, MANY2MANY)
  • For CCVPN Usecase(3)

  • (2) IF this EXT-AAI-NETWORK node is deleted, this TO node is DELETED also
  • (3) IF this FROM node is deleted, this EXT-AAI-NETWORK is DELETED also
  • EXT-AAI-NETWORK cannot be deleted if related to CONNECTIVITY,DEVICE,LAN-PORT-CONFIG,LOGICAL-LINK,NETWORK-RESOURCE,PNF,SDWAN-VPN,SITE-RESOURCE,VPN-BINDING,WAN-PORT-CONFIG
aai-id: string

Unique ID of the referenced AAI.

schema-version: string

Schema version of the referenced AAI.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

esr-system-info: object
relationship-list: object[]

ext-aai-networks: object

ext-aai-network: object[]

external-system: object

Namespace for external system.

esr-ems-list: object
esr-vnfm-list: object
esr-thirdparty-sdnc-list: object

extra-properties: object

Extra properties for inventory item for response list

extra-property: object[]

extra-property: object

property-name: string
property-value: string

flavor: object

Openstack flavor.

  • TO cloud-region (PARENT of flavor, flavor BelongsTo cloud-region, MANY2ONE)
  • TO pserver( flavor CanBeInstantiatedIn pserver, MANY2MANY)
  • HPA Capacity getting the compute nodes from given flavor

  • FROM hpa-capability (CHILD of flavor, hpa-capability BelongsTo flavor, MANY2ONE)
  • FROM vserver( vserver Uses flavor, MANY2ONE)
  • FLAVOR cannot be deleted if related to HPA-CAPABILITY,VSERVER
flavor-id: string

Flavor id, expected to be unique across cloud-region.

flavor-name: string

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

hpa-capabilities: object[]
relationship-list: object[]

flavors: object

Collection of openstack flavors.

flavor: object[]

forwarder: object

Entity describing a sequenced segment of forwarding path

  • TO configuration( forwarder Uses configuration, ONE2ONE)(2)
  • TO forwarding-path (PARENT of forwarder, forwarder BelongsTo forwarding-path, MANY2ONE)(4)
  • TO generic-vnf( forwarder AppliesTo generic-vnf, MANY2MANY)
  • Points to the generic-vnf(s) involved in this forwarding step.

  • TO l-interface( forwarder ForwardsTo l-interface, MANY2MANY)
  • TO lag-interface( forwarder ForwardsTo lag-interface, MANY2MANY)
  • TO p-interface( forwarder ForwardsTo p-interface, MANY2MANY)
  • (2) IF this FORWARDER node is deleted, this TO node is DELETED also
  • (4) IF this TO node is deleted, this FORWARDER is DELETED also
sequence: integer

Unique ID of this segmentation

forwarder-role: string

ingress, intermediate, egress

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]

forwarder-evc: object

forwarder object is an optional child object of the Configuration object.

  • TO configuration (PARENT of forwarder-evc, forwarder-evc BelongsTo configuration, ONE2ONE)(4)
  • FROM vlan-mapping (CHILD of forwarder-evc, vlan-mapping BelongsTo forwarder-evc, MANY2ONE)(1)
  • (1) IF this FORWARDER-EVC node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
forwarder-evc-id: string

Key for forwarder-evc object

circuit-id: string

Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC

ivlan: string

Internal VLAN.

svlan: string

SVLAN value for ingress of egress forwarder.

cvlan: string

CVLAN value for ingress of egress forwarder.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

vlan-mappings: object[]
relationship-list: object[]

forwarder-evcs: object

forwarder-evc: object[]

forwarders: object

forwarder: object[]

forwarding-path: object

Entity that describes the sequenced forwarding path between interfaces of services or resources

  • TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
  • TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
  • FROM forwarder (CHILD of forwarding-path, forwarder BelongsTo forwarding-path, MANY2ONE)(1)
  • (1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
  • (2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
  • (4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
forwarding-path-id: string

Unique ID of this FP

forwarding-path-name: string

Name of the FP

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

selflink: string

the self link for this FP

relationship-list: object[]
forwarders: object[]

forwarding-paths: object

forwarding-path: object[]

generic-vnf: object

General purpose VNF

  • TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
  • TO complex( generic-vnf LocatedIn complex, MANY2MANY)
  • TO configuration( generic-vnf Uses configuration, ONE2MANY)(2)
  • TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY)
  • TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
  • TO instance-group( generic-vnf Uses instance-group, ONE2MANY)
  • TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
  • TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
  • TO nos-server( generic-vnf HostedOn nos-server, MANY2ONE)
  • TO pnf( generic-vnf HostedOn pnf, MANY2MANY)
  • TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
  • TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
  • TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
  • TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
  • TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
  • FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
  • FROM device( device Uses generic-vnf, ONE2MANY)
  • For CCVPN Usecase

  • FROM entitlement (CHILD of generic-vnf, entitlement BelongsTo generic-vnf, MANY2ONE)(1)
  • FROM forwarder( forwarder AppliesTo generic-vnf, MANY2MANY)
  • Points to the generic-vnf(s) involved in this forwarding step.

  • FROM instance-group( instance-group BelongsTo generic-vnf, MANY2ONE)(1)
  • FROM l-interface (CHILD of generic-vnf, l-interface BelongsTo generic-vnf, MANY2ONE)(1)
  • FROM lag-interface (CHILD of generic-vnf, lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
  • FROM license (CHILD of generic-vnf, license BelongsTo generic-vnf, MANY2ONE)(1)
  • FROM line-of-business( line-of-business Uses generic-vnf, MANY2MANY)
  • FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
  • FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
  • FROM platform( platform Uses generic-vnf, MANY2MANY)
  • FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
  • FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
  • FROM vf-module (CHILD of generic-vnf, vf-module BelongsTo generic-vnf, MANY2ONE)(1)
  • FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
  • (1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
  • (2) IF this GENERIC-VNF node is deleted, this TO node is DELETED also
vnf-id: string

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

vnf-instance-id: string

vnf instance id.

vnf-name: string

Name of VNF.

vnf-name2: string

Alternate name of VNF.

vnf-type: string

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

service-id: string

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

regional-resource-zone: string

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

prov-status: string

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

operational-status: string

Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.

license-key: string

OBSOLETE - do not use

equipment-role: string

Client should send valid enumerated value

orchestration-status: string

Orchestration status of this VNF, used by MSO.

vnf-package-name: string
vnf-discriptor-name: string

vnf discriptor name

job-id: string

job id corresponding to vnf

heat-stack-id: string

Heat stack id corresponding to this instance, managed by MSO

mso-catalog-key: string

Corresponds to the SDN-C catalog id used to configure this VCE

management-option: string

identifier of managed 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

nshd: integer

number of associated SHD in vnf.

nvm: integer

number of vms in vnf.

nnet: integer

number of network in vnf.

in-maint: boolean

used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.

is-closed-loop-disabled: boolean

used to indicate whether closed loop function is enabled on this node

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

summary-status: string

details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.

encrypted-access-flag: boolean

indicates whether generic-vnf access uses SSH

entitlement-assignment-group-uuid: string

UUID of the Entitlement group used for licensing VNFs, OBSOLETE - See child relationships.

entitlement-resource-uuid: string

UUID of the specific entitlement resource. OBSOLETE - See child relationships.

license-assignment-group-uuid: string

UUID of the license assignment group. OBSOLETE - See child relationships.

license-key-uuid: string

UUID of the actual license resource. OBSOLETE - See child relationships.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

persona-model-version: string

the ASDC model version for this resource or service model.

model-customization-id: string

captures the id of all the configuration used to customize the resource for the service.

widget-model-id: string

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

widget-model-version: string

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

as-number: string

as-number of the VNF

regional-resource-subzone: string

represents sub zone of the rr plane

nf-type: string

Generic description of the type of NF

nf-function: string

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

nf-role: string

role in the network that this model will be providing

nf-naming-code: string

string assigned to this model used for naming purposes

selflink: string

Path to the controller object.

ipv4-oam-gateway-address: string

Gateway address

ipv4-oam-gateway-address-prefix-length: integer

Prefix length for oam-address

vlan-id-outer: integer

Temporary location for S-TAG to get to VCE

nm-profile-name: string

Network Management profile of this VNF

relationship-list: object[]
l-interfaces: object[]
lag-interfaces: object[]
vf-modules: object[]
licenses: object[]
entitlements: object[]

generic-vnfs: object

Collection of VNFs

generic-vnf: object[]

group-assignment: object

Openstack group-assignment used to store exclusivity groups (EG).

  • TO cloud-region (PARENT of group-assignment, group-assignment BelongsTo cloud-region, MANY2ONE)
  • FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
  • FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
group-id: string

Group id, expected to be unique across cloud-region.

group-type: string

Group type - the type of group this instance refers to

group-name: string

Group name - name assigned to the group

group-description: string

Group description - description of the group

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]

group-assignments: object

Collection of openstack group assignments

group-assignment: object[]

host-route: object

  • TO subnet (PARENT of host-route, host-route BelongsTo subnet, MANY2ONE)(4)
  • (4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
host-route-id: string

host-route id

route-prefix: string

subnet prefix

next-hop: string

Could be ip-address, hostname, or service-instance

next-hop-type: string

Should be ip-address, hostname, or service-instance to match next-hop

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]

host-routes: object

host-route: object[]

hpa-capabilities: object

Collection of HPA Capabilities

hpa-capability: object[]

hpa-capability: object

Represents a HPA capability

  • TO cloud-region (PARENT of hpa-capability, hpa-capability BelongsTo cloud-region, MANY2ONE)
  • TO flavor (PARENT of hpa-capability, hpa-capability BelongsTo flavor, MANY2ONE)
  • FROM hpa-feature-attributes (CHILD of hpa-capability, hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
  • (1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
hpa-capability-id: string

UUID to uniquely identify a HPA capability

hpa-feature: string

Name of the HPACapability

hpa-version: string

HPA schema version

architecture: string

Hardware architecture

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]
hpa-feature-attributes: object[]

hpa-capacity: object

HPA Capacity information for compute node

  • TO pserver (PARENT of hpa-capacity, hpa-capacity BelongsTo pserver, MANY2ONE)
  • HPA Capacity KV for given compute node(4)

  • (4) IF this TO node is deleted, this HPA-CAPACITY is DELETED also
hpa-capacity-key: string

Composite key formed with hpaFeature and append list of hpaFeatureAttributes needed for capacity check

hpa-capacity-value: string

JSON string specifying the capacity (total,free), unit and metadata of the specific HPA attribute

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]

hpa-feature-attributes: object

HPA Capability Feature attributes

  • TO hpa-capability (PARENT of hpa-feature-attributes, hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
  • (4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
hpa-attribute-key: string

name of the specific HPA attribute

hpa-attribute-value: string

JSON string specifying the value, unit and type of the specific HPA attribute

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]

image: object

Openstack image.

  • TO cloud-region (PARENT of image, image BelongsTo cloud-region, MANY2ONE)
  • FROM metadatum (CHILD of image, metadatum BelongsTo image, MANY2ONE)(1)
  • FROM vserver( vserver Uses image, MANY2ONE)
  • (1) IF this IMAGE node is deleted, this FROM node is DELETED also
  • IMAGE cannot be deleted if related to VSERVER
image-id: string

Image id, expected to be unique across cloud region

image-name: string

Image name

image-architecture: string

Operating system architecture.

image-os-distro: string

The common name of the operating system distribution in lowercase

image-os-version: string

The operating system version as specified by the distributor.

application: string

The application that the image instantiates.

application-vendor: string

The vendor of the application.

application-version: string

The version of the application.

image-selflink: string

URL to endpoint where AAI can get more details

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]
metadata: object[]

images: object

Collectio of Openstack images.

image: object[]

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-group: object

General mechanism for grouping instances

  • TO collection( instance-group BelongsTo collection, ONE2ONE)
  • TO generic-vnf( instance-group BelongsTo generic-vnf, MANY2ONE)(4)
  • TO model( instance-group Targets model, MANY2MANY)
  • FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
  • FROM cloud-region( cloud-region Uses instance-group, ONE2MANY)
  • FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
  • FROM generic-vnf( generic-vnf Uses instance-group, ONE2MANY)
  • FROM l-interface( l-interface MemberOf instance-group, MANY2MANY)
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
  • FROM l3-network( l3-network MemberOf instance-group, MANY2MANY)
  • FROM pnf( pnf MemberOf instance-group, MANY2MANY)
  • FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
  • FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
  • FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
  • FROM vnfc( vnfc MemberOf instance-group, MANY2MANY)
  • (4) IF this TO node is deleted, this INSTANCE-GROUP is DELETED also
id: string

Instance Group ID, UUID assigned to this instance.

instance-group-role: string

role of the instance group.

model-invariant-id: string

ASDC model id for this resource or service model.

model-version-id: string

ASDC model version uid for this resource model.

description: string

Descriptive text to help identify the usage of this instance-group

instance-group-type: string

Only valid value today is lower case ha for high availability

resource-version: string

Concurrency value

instance-group-name: string

Instance-Group Name.

instance-group-function: string

Instance-Group Function

relationship-list: object[]

instance-groups: object

Collection of openstack route table references

instance-group: object[]

inventory: object

cloud-infrastructure: object
external-system: object
business: object
service-design-and-creation: object
network: object

inventory-item: object

inventory-item-type: string
inventory-item-link: string
inventory-item-data: object[]
tagged-inventory-item-list: object[]

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
inventory-response-items: object

inventory-response-items: object

Container for inventory items in response list

inventory-response-item: object[]

ipsec-configuration: object

IPSec configuration node will contain various configuration data for the NMTE VNF. This node will have an edge to the generic-vnf (vnf type = TE). Starting 1607, this data will be populated by SDN-C

  • FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
  • FROM vig-server (CHILD of ipsec-configuration, vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
  • (1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
ipsec-configuration-id: string

UUID of this configuration

requested-vig-address-type: string

Indicate the type of VIG server like AVPN, INTERNET, BOTH

requested-encryption-strength: string

Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc

requested-dmz-type: string

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[]
vig-servers: object[]

ipsec-configurations: object

ipsec-configuration: object[]

key-data: object

key-name: string
key-value: string

l-interface: object

Logical interfaces, e.g., a vnic.

  • TO cp( l-interface LinksTo cp, ONE2ONE)
  • TO generic-vnf (PARENT of l-interface, l-interface BelongsTo generic-vnf, MANY2ONE)(4)
  • TO instance-group( l-interface MemberOf instance-group, MANY2MANY)
  • TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
  • TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
  • TO newvce (PARENT of l-interface, l-interface BelongsTo newvce, MANY2ONE)(4)
  • TO p-interface (PARENT of l-interface, l-interface BindsTo p-interface, MANY2ONE)(4)
  • TO vserver (PARENT of l-interface, l-interface BindsTo vserver, MANY2ONE)(4)
  • TO lag-interface (PARENT of l-interface, l-interface BelongsTo lag-interface, MANY2ONE)(4)
  • FROM allotted-resource( allotted-resource Uses l-interface, ONE2MANY)
  • FROM configuration( configuration AppliesTo l-interface, ONE2MANY)
  • FROM forwarder( forwarder ForwardsTo l-interface, MANY2MANY)
  • FROM l-interface (PARENT of l-interface, l-interface BelongsTo l-interface, MANY2ONE)(4)
  • FROM logical-link( logical-link Source l-interface, MANY2MANY)(1)
  • FROM logical-link( logical-link Destination l-interface, MANY2MANY)(1)
  • FROM sriov-vf (CHILD of l-interface, sriov-vf BelongsTo l-interface, ONE2ONE)(1)
  • FROM vlan (CHILD of l-interface, vlan LinksTo l-interface, MANY2ONE)(1)
  • FROM l3-interface-ipv4-address-list (CHILD of l-interface, l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
  • FROM l3-interface-ipv6-address-list (CHILD of l-interface, l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
  • FROM lag-interface( lag-interface Uses l-interface, ONE2MANY)
  • (1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
  • (2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
  • (4) IF this TO node is deleted, this L-INTERFACE is DELETED also
interface-name: string

Name given to the interface

interface-role: string

E.g., CUSTOMER, UPLINK, etc.

v6-wan-link-ip: string

Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.

selflink: string

URL to endpoint where AAI can get more details

interface-id: string

ID of interface

macaddr: string

MAC address for the interface

network-name: string

Name of the network

management-option: string

Whether A&AI should be managing this interface of not. Could have value like CUSTOMER

interface-description: string

Human friendly text regarding this interface.

is-port-mirrored: boolean

boolean indicatating whether or not port is a mirrored.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

in-maint: boolean

used to indicate whether or not this object is in maintenance mode (maintenance mode = true)

prov-status: string

Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].

is-ip-unnumbered: boolean

Flag indicating the interface uses the IP Unnumbered configuration.

allowed-address-pairs: string

Freeform field for storing an ip address, list of ip addresses or a subnet block.

admin-status: string

Administrative status of the interface. Valid values are 'up', 'down', or 'testing'.

vlans: object[]
sriov-vfs: object[]
l-interfaces: object[]
relationship-list: object[]
l3-interface-ipv4-address-list: object[]
l3-interface-ipv6-address-list: object[]

l-interfaces: object

Collection of logical interfaces.

l-interface: object[]

l3-interface-ipv4-address-list: object

IPv4 Address Range

  • TO cp (PARENT of l3-interface-ipv4-address-list, l3-interface-ipv4-address-list BelongsTo cp, MANY2ONE)(4)
  • TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
  • TO l-interface (PARENT of l3-interface-ipv4-address-list, l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
  • TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
  • TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
  • TO vlan (PARENT of l3-interface-ipv4-address-list, l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
  • TO vnfc (PARENT of l3-interface-ipv4-address-list, l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(4)
  • (4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
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[]

l3-interface-ipv6-address-list: object

IPv6 Address Range

  • TO cp (PARENT of l3-interface-ipv6-address-list, l3-interface-ipv6-address-list BelongsTo cp, MANY2ONE)(4)
  • TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
  • TO l-interface (PARENT of l3-interface-ipv6-address-list, l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
  • TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
  • TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
  • TO vlan (PARENT of l3-interface-ipv6-address-list, l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
  • TO vnfc (PARENT of l3-interface-ipv6-address-list, l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(4)
  • (4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
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[]

l3-network: object

Generic network definition

  • TO cp( l3-network LinksTo cp, MANY2MANY)
  • TO instance-group( l3-network MemberOf instance-group, MANY2MANY)
  • TO l3-network( l3-network Uses l3-network, MANY2MANY)
  • TO network-policy( l3-network Uses network-policy, MANY2MANY)
  • TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
  • TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
  • FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
  • FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
  • FROM complex( complex Uses l3-network, MANY2MANY)
  • FROM configuration( configuration PartOf l3-network, ONE2ONE)
  • FROM ctag-assignment (CHILD of l3-network, ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
  • FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
  • FROM l3-network( l3-network Uses l3-network, MANY2MANY)
  • FROM line-of-business( line-of-business Uses l3-network, MANY2MANY)
  • FROM platform( platform Uses l3-network, MANY2MANY)
  • FROM segmentation-assignment (CHILD of l3-network, segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
  • FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
  • FROM subnet (CHILD of l3-network, subnet BelongsTo l3-network, MANY2ONE)(1)
  • FROM tenant( tenant Uses l3-network, MANY2MANY)
  • FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
  • FROM vlan-tag( vlan-tag BelongsTo l3-network, MANY2MANY)
  • (1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
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

Set to true if bound to VPN

service-id: string

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

network-role-instance: integer

network role instance

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

orchestration-status: string

Orchestration status of this VNF, mastered by MSO

heat-stack-id: string

Heat stack id corresponding to this instance, managed by MSO

mso-catalog-key: string

Corresponds to the SDN-C catalog id used to configure this VCE

contrail-network-fqdn: string

Contrail FQDN for the network

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

persona-model-version: string

the ASDC model version for this resource or service model.

model-customization-id: string

captures the id of all the configuration used to customize the resource for the service.

widget-model-id: string

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

widget-model-version: string

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

physical-network-name: string

Name associated with the physical network.

is-provider-network: boolean

boolean indicatating whether or not network is a provider network.

is-shared-network: boolean

boolean indicatating whether or not network is a shared network.

is-external-network: boolean

boolean indicatating whether or not network is an external network.

selflink: string

Path to the controller object.

operational-status: string

Indicator for whether the resource is considered operational.

is-trunked: boolean

Trunked network indication.

subnets: object[]
ctag-assignments: object[]
segmentation-assignments: object[]
relationship-list: object[]

l3-networks: object

l3-network: object[]

lag-interface: object

Link aggregate interface

  • TO generic-vnf (PARENT of lag-interface, lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
  • TO l-interface( lag-interface Uses l-interface, ONE2MANY)
  • TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
  • TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2)
  • TO p-interface( lag-interface Uses p-interface, MANY2MANY)
  • TO pnf (PARENT of lag-interface, lag-interface BindsTo pnf, MANY2ONE)(4)
  • TO pserver (PARENT of lag-interface, lag-interface BindsTo pserver, MANY2ONE)(4)
  • TO vpls-pe (PARENT of lag-interface, lag-interface BindsTo vpls-pe, MANY2ONE)(4)
  • FROM forwarder( forwarder ForwardsTo lag-interface, MANY2MANY)
  • FROM l-interface (CHILD of lag-interface, l-interface BelongsTo lag-interface, MANY2ONE)(1)
  • (1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
  • (2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
  • (4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
interface-name: string

Name that identifies the link aggregate interface

interface-description: string

Human friendly text regarding this interface.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

speed-value: string

Captures the numeric part of the speed

speed-units: string

Captures the units corresponding to the speed

interface-id: string

ID of interface

interface-role: string

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

prov-status: string

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

in-maint: boolean

used to indicate whether or not this object is in maintenance mode (maintenance mode = true)

relationship-list: object[]
l-interfaces: object[]

lag-interfaces: object

Collection of link aggregate interfaces.

lag-interface: object[]

lan-port-config: object

Instance of a lan-port-config

  • TO dhcp-service (PARENT of lan-port-config, lan-port-config Uses dhcp-service, ONE2MANY)
  • For CCVPN Usecase(2)

  • TO ext-aai-network( lan-port-config BelongsTo ext-aai-network, MANY2MANY)
  • For CCVPN Usecase(2)

  • TO service-instance( lan-port-config PartOf service-instance, ONE2MANY)
  • For CCVPN Usecase

  • (2) IF this LAN-PORT-CONFIG node is deleted, this TO node is DELETED also
lan-port-config-id: string

Uniquely identifies this lan-port-config by id

lan-port-config-name: string

Store the name of this lan-port-config.

description: string

Store the description of this lan-port-config.

device-id: string

Store the device-id of this lan-port-config.

port-id: string

Store the port-id of this lan-port-config.

ipv4-address: string

Store the ipv4-address of this lan-port-config.

ipv6-address: string

Store the ipv6-address of this lan-port-config.

vlan-tag: string

Store the vlan-tag of this lan-port-config.

input-bandwidth: string

Store the input-bandwidth of this lan-port-config.

output-bandwidth: string

Store the output-bandwidth of this lan-port-config.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

dhcp-services: object[]
relationship-list: object[]

lan-port-configs: object

Collection of lan-port-configs

lan-port-config: object[]

license: object

Metadata for license group.

  • TO generic-vnf (PARENT of license, license BelongsTo generic-vnf, MANY2ONE)(4)
  • TO vce (PARENT of license, license BelongsTo vce, MANY2ONE)(4)
  • (4) IF this TO node is deleted, this LICENSE is DELETED also
group-uuid: string

Unique ID for the license group the resource belongs to, should be uuid.

resource-uuid: string

Unique ID of a license resource.

resource-version: string

Concurrency value

relationship-list: object[]

licenses: object

Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management

license: object[]

line-of-business: object

describes a line-of-business

  • TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
  • TO l3-network( line-of-business Uses l3-network, 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[]

lines-of-business: object

Collection of lines-of-business

line-of-business: object[]

metadata: object

Collection of metadatum (key/value pairs)

metadatum: object[]

metadatum: object

Key/value pairs

  • TO configuration (PARENT of metadatum, metadatum BelongsTo configuration, MANY2ONE)(4)
  • TO connector (PARENT of metadatum, metadatum BelongsTo connector, MANY2ONE)(4)
  • TO image (PARENT of metadatum, metadatum BelongsTo image, MANY2ONE)(4)
  • TO model-ver (PARENT of metadatum, metadatum BelongsTo model-ver, MANY2ONE)(4)
  • TO service-instance (PARENT of metadatum, metadatum BelongsTo service-instance, MANY2ONE)(4)
  • (4) IF this TO node is deleted, this METADATUM is DELETED also
metaname: string
metaval: string
resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

model: object

Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version

  • FROM instance-group( instance-group Targets model, MANY2MANY)
  • FROM model-ver (CHILD of model, model-ver BelongsTo model, MANY2ONE)(1)
  • FROM named-query( named-query AppliesTo model, ONE2MANY)
  • FROM named-query-element( named-query-element IsA model, MANY2ONE)
  • (1) IF this MODEL node is deleted, this FROM node is DELETED also
  • MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
model-invariant-id: string

Unique identifier corresponding to the main definition of a model in ASDC

model-type: string

Type of the model, e.g., service, resource, widget, etc.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

model-vers: object[]
relationship-list: object[]

model-constraint: object

This is how we would capture constraints defining allowed sets of elements.

  • TO model-element (PARENT of model-constraint, model-constraint BelongsTo model-element, MANY2ONE)(4)
  • FROM constrained-element-set (CHILD of model-constraint, constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
  • (1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
model-constraint-uuid: string
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[]

model-constraints: object

model-constraint: object[]

model-element: object

Defines how other models combine to make up a higher-level model.

  • TO element-choice-set (PARENT of model-element, model-element BelongsTo element-choice-set, MANY2ONE)(4)
  • TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
  • TO model-ver( model-element IsA model-ver, MANY2ONE)
  • TO model-ver (PARENT of model-element, model-element BelongsTo model-ver, MANY2ONE)(4)
  • FROM constrained-element-set (CHILD of model-element, constrained-element-set BelongsTo model-element, MANY2ONE)(1)
  • FROM model-constraint (CHILD of model-element, model-constraint BelongsTo model-element, MANY2ONE)(1)
  • FROM model-element (PARENT of model-element, model-element BelongsTo model-element, MANY2ONE)(4)
  • (1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
model-element-uuid: string
new-data-del-flag: string

Indicates whether this element was created as part of instantiation from this model

cardinality: string

How many of this type of element are required/allowed

linkage-points: string
resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

model-elements: object[]
model-constraints: object[]
relationship-list: object[]

model-elements: object

model-element: object[]

model-ver: object

Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models

  • TO model (PARENT of model-ver, model-ver BelongsTo model, MANY2ONE)(4)
  • FROM metadatum (CHILD of model-ver, metadatum BelongsTo model-ver, MANY2ONE)(1)
  • FROM model-element( model-element IsA model-ver, MANY2ONE)
  • FROM model-element (CHILD of model-ver, model-element BelongsTo model-ver, MANY2ONE)(1)
  • (1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this MODEL-VER is DELETED also
  • MODEL-VER cannot be deleted if related to MODEL-ELEMENT
model-version-id: string

Unique identifier corresponding to one version of a model in ASDC

model-name: string

Name of the model, which can change from version to version.

model-version: string

Version

distribution-status: string

Distribution Status

model-description: string

Description

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

model-elements: object[]
metadata: object[]
relationship-list: object[]

model-vers: object

model-ver: object[]

models: object

Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models

model: object[]

multicast-configuration: object

  • FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
multicast-configuration-id: string

Unique id of multicast configuration.

multicast-protocol: string

protocol of multicast configuration

rp-type: string

rp type of multicast configuration

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]

multicast-configurations: object

multicast configuration of generic-vnf ip-address

multicast-configuration: object[]

named-queries: object

named-query: object[]

named-query: object

TBD

  • TO model( named-query AppliesTo model, ONE2MANY)
  • FROM named-query-element (CHILD of named-query, named-query-element BelongsTo named-query, ONE2ONE)(1)
  • (1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
named-query-uuid: string
named-query-name: string
named-query-version: string
required-input-param: string
description: string
resource-version: string
named-query-elements: object[]
relationship-list: object[]

named-query-element: object

TBD

  • TO model( named-query-element IsA model, MANY2ONE)
  • TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
  • TO named-query (PARENT of named-query-element, named-query-element BelongsTo named-query, ONE2ONE)(4)
  • FROM named-query-element (PARENT of named-query-element, named-query-element BelongsTo named-query-element, MANY2ONE)(4)
  • FROM property-constraint (CHILD of named-query-element, property-constraint BelongsTo named-query-element, MANY2ONE)(1)
  • FROM related-lookup (CHILD of named-query-element, related-lookup BelongsTo named-query-element, MANY2ONE)(1)
  • (1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
named-query-element-uuid: string
property-collect-list: string
resource-version: string
property-limit-desc: string
do-not-output: string
named-query-elements: object[]
related-lookups: object[]
property-constraints: object[]
relationship-list: object[]

named-query-elements: object

named-query-element: object[]

network: object

Namespace for network inventory resources.

logical-links: object[]
site-pair-sets: object[]
vpn-bindings: object[]
vpls-pes: object[]
multicast-configurations: object[]
vces: object[]
vce
vnfcs: object[]
l3-networks: object[]
network-policies: object[]
generic-vnfs: object[]
lag-links: object[]
newvces: object[]
pnfs: object[]
pnf
physical-links: object[]
ipsec-configurations: object[]
route-table-references: object[]
instance-groups: object[]
zones: object[]
configurations: object[]
forwarding-paths: object[]
collections: object[]
vlan-tags: object[]
connectivities: object[]
lan-port-configs: object[]
network-resources: object[]
site-resources: object[]
sdwan-vpns: object[]
devices: object[]
wan-port-configs: object[]
ext-aai-networks: object[]

network-policies: object

network-policy: object[]

network-policy: object

  • FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE)
  • FROM l3-network( l3-network Uses network-policy, MANY2MANY)
network-policy-id: string

UUID representing unique key to this instance

network-policy-fqdn: string

Contrail FQDN for the policy

heat-stack-id: string

ID for the openStack Heat instance

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]

network-profile: object

Network profile populated by SDN-GP for SNMP

  • TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
nm-profile-name: string

Unique name of network profile.

community-string: string

Encrypted SNMP community string

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]

network-profiles: object

Collection of network profiles

network-profile: object[]

network-resource: object

Instance of a network-resource

  • TO ext-aai-network( network-resource BelongsTo ext-aai-network, MANY2MANY)
  • For CCVPN Usecase(2)

  • TO vpn-binding( network-resource Uses vpn-binding, ONE2MANY)
  • For CCVPN Usecase

  • FROM pnf( pnf LinksTo network-resource, MANY2MANY)
  • For CCVPN Usecase(1)

  • (1) IF this NETWORK-RESOURCE node is deleted, this FROM node is DELETED also
  • (2) IF this NETWORK-RESOURCE node is deleted, this TO node is DELETED also
network-id: string

Uniquely identifies this network-resource by id

provider-id: string

Store the id of the provider of this network-resource.

client-id: string

Store the id of the client of this network-resource.

te-topo-id: string

Store the id of the te-topo of this network-resource.

selflink: string

Store the link to get more information for this object.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]

network-resources: object

Collection of network-resources

network-resource: object[]

network-technologies: object

The network-technology object is used to capture the supported network technologies of a cloud-region.

network-technology: object[]

network-technology: object

The network-technology object is used to capture the supported network technologies of a cloud-region.

  • FROM cloud-region( cloud-region Uses network-technology, MANY2MANY)
network-technology-id: string

Unique identifier of the network-technology object (UUID)

network-technology-name: string

The network-technology that a cloud-region can support. Current valid values- CONTRAIL AIC_SR_IOV OVS STANDARD-SR-IOV

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]

newvce: object

This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.

  • FROM l-interface (CHILD of newvce, l-interface BelongsTo newvce, MANY2ONE)(1)
  • (1) IF this NEWVCE node is deleted, this FROM node is DELETED also
vnf-id2: string

Unique id of VNF, can't use same attribute name right now until we promote this new object

vnf-name: string

Name of VNF.

vnf-name2: string

Alternate name of VNF.

vnf-type: string

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

prov-status: string

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

operational-status: string

Indicator for whether the resource is considered operational

license-key: string

OBSOLETE - do not use

ipv4-oam-address: string

Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).

equipment-role: string

Client should send valid enumerated value.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

ipv4-loopback0-address: string

v4 Loopback0 address

orchestration-status: string

Orchestration status of this VNF, mastered by MSO.

heat-stack-id: string

Heat stack id corresponding to this instance, managed by MSO

mso-catalog-key: string

Corresponds to the SDN-C catalog id used to configure this VCE

relationship-list: object[]
l-interfaces: object[]

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

nodes: object

inventory-item-data: object[]

nos-server: object

nos-server is the execution environment that will have images, certain versions of VNOS, running on it.

  • TO pserver( nos-server HostedOn pserver, ONE2ONE)
  • TO tenant (PARENT of nos-server, nos-server BelongsTo tenant, MANY2ONE)
  • FROM generic-vnf( generic-vnf HostedOn nos-server, MANY2ONE)
nos-server-id: string

Unique identifier for this nos relative to its tenant

nos-server-name: string

Name of nos

vendor: string

uCPE vendor

prov-status: string

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

nos-server-selflink: string

URL to endpoint where AAI can get more details

in-maint: boolean

Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]

nos-servers: object

nos-server is the execution environment that will have images, certain versions of VNOS, running on it.

nos-server: object[]

notification-event: object

cambria.partition: string
notification-event-header: object

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

oam-network: object

OAM network, to be deprecated shortly. Do not use for new purposes.

  • TO cloud-region (PARENT of oam-network, oam-network BelongsTo cloud-region, MANY2ONE)
  • TO complex( oam-network AppliesTo complex, MANY2MANY)
  • TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
network-uuid: string

UUID of the network. Unique across a cloud-region

network-name: string

Name of the network.

cvlan-tag: integer

cvlan-id

ipv4-oam-gateway-address: string

Used for VNF firewall rule so customer cannot send customer traffic over this oam network

ipv4-oam-gateway-address-prefix-length: integer

Used for VNF firewall rule so customer cannot send customer traffic over this oam network

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]

oam-networks: object

Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.

oam-network: object[]

operational-environment: object

It is a logical partition of the cloud which allows to have multiple environments in the production AIC.

  • TO operational-environment( operational-environment Uses operational-environment, MANY2MANY)
  • FROM operational-environment( operational-environment Uses operational-environment, MANY2MANY)
operational-environment-id: string

UUID of an operational environment

operational-environment-name: string

Operational Environment name

operational-environment-type: string

Operational Environment Type.

operational-environment-status: string

Status

tenant-context: string

Tenant Context.

workload-context: string

Workload Context.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]

operational-environments: object

a logical partition of the cloud which allows to have multiple environments in the production AIC.

operational-environment: object[]

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
relationship-list: object

owning-entities: object

Collection of owning-entities

owning-entity: object[]

owning-entity: object

describes an owning-entity

  • FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
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[]

p-interface: object

Physical interface (e.g., nic)

  • TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
  • TO pnf (PARENT of p-interface, p-interface BindsTo pnf, MANY2ONE)(4)
  • TO pserver (PARENT of p-interface, p-interface BindsTo pserver, MANY2ONE)(4)
  • TO vpls-pe (PARENT of p-interface, p-interface BindsTo vpls-pe, MANY2ONE)(4)
  • TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
  • FROM forwarder( forwarder ForwardsTo p-interface, MANY2MANY)
  • FROM l-interface (CHILD of p-interface, l-interface BindsTo p-interface, MANY2ONE)(1)
  • FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
  • FROM sriov-pf (CHILD of p-interface, sriov-pf BelongsTo p-interface, ONE2ONE)(1)
  • FROM vpn-binding( vpn-binding BindsTo p-interface, ONE2MANY)
  • For CCVPN Usecase

  • (1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
  • (2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
  • (4) IF this TO node is deleted, this P-INTERFACE is DELETED also
interface-name: string

Name that identifies the physical interface

selflink: string

URL to endpoint where AAI can get more details.

speed-value: string

Captures the numeric part of the speed

speed-units: string

Captures the units corresponding to the speed

port-description: string

Nature of the services and connectivity on this port.

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

used to indicate whether or not this object is in maintenance mode (maintenance mode = true)

inv-status: string

inventory status

network-ref: string

Store the network-ref of this p-interface. Derived from ietf-restconf-notification that identifies a termination-point.

transparent: string

Store the transparent value of this p-interface.

operational-status: string

oper Status of this p-interface.

relationship-list: object[]
sriov-pfs: object[]
l-interfaces: object[]

p-interfaces: object

Collection of physical interfaces.

p-interface: object[]

platform: object

describes a platform

  • TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
  • TO l3-network( platform Uses l3-network, 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[]

platforms: object

Collection of platforms

platform: object[]

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 complex( pnf LocatedIn complex, MANY2ONE)
  • TO ext-aai-network( pnf BelongsTo ext-aai-network, MANY2MANY)
  • For CCVPN Usecase(2)

  • TO instance-group( pnf MemberOf instance-group, MANY2MANY)
  • TO network-resource( pnf LinksTo network-resource, MANY2MANY)
  • For CCVPN Usecase(4)

  • TO zone( pnf LocatedIn zone, MANY2ONE)
  • FROM configuration( configuration AppliesTo pnf, MANY2MANY)
  • FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
  • FROM generic-vnf( generic-vnf HostedOn pnf, MANY2MANY)
  • FROM lag-interface (CHILD of pnf, lag-interface BindsTo pnf, MANY2ONE)(1)
  • FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
  • FROM p-interface (CHILD of pnf, p-interface BindsTo pnf, MANY2ONE)(1)
  • FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
  • FROM software-version (CHILD of pnf, software-version BelongsTo pnf, MANY2ONE)
  • (1) IF this PNF node is deleted, this FROM node is DELETED also
  • (2) IF this PNF node is deleted, this TO node is DELETED also
  • (4) IF this TO node is deleted, this PNF is DELETED also
  • PNF cannot be deleted if related to NETWORK-RESOURCE,SOFTWARE-VERSION
pnf-name: string

unique name of Physical Network Function.

pnf-name2: string

name of Physical Network Function.

selflink: string

URL to endpoint where AAI can get more details.

pnf-name2-source: string

source of name2

pnf-id: string

id of pnf

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

Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.

frame-id: string

ID of the physical frame (relay rack) where pnf is installed.

serial-number: string

Serial number of the device

ipaddress-v4-loopback-0: string

IPV4 Loopback 0 address

ipaddress-v6-loopback-0: string

IPV6 Loopback 0 address

ipaddress-v4-aim: string

IPV4 AIM address

ipaddress-v6-aim: string

IPV6 AIM address

ipaddress-v6-oam: string

IPV6 OAM address

inv-status: string

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

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

prov-status: string

Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]

nf-role: string

Nf Role is the role performed by this instance in the network.

admin-status: string

admin Status of this PNF

operational-status: string

Store the operational-status for this object.

model-customization-id: string

Store the model-customization-id for this object.

model-invariant-id: string

The ASDC model id for this resource model.

model-version-id: string

The ASDC model version for this resource model.

pnf-ipv4-address: string

This is the IP address (IPv4) for the PNF itself. This is the IPv4 address that the PNF iself can be accessed at.

pnf-ipv6-address: string

This is the IP address (IPv6) for the PNF itself. This is the IPv6 address that the PNF iself can be accessed at.

software-versions: object[]
relationship-list: object[]
p-interfaces: object[]
lag-interfaces: object[]

pnfs: object

Collection of Physical Network Functions.

pnf: object[]
pnf

port-group: object

Used to capture the network interfaces of this VCE

  • TO vce (PARENT of port-group, port-group BelongsTo vce, MANY2ONE)(4)
  • FROM cvlan-tag (CHILD of port-group, cvlan-tag BelongsTo port-group, MANY2ONE)(1)
  • (1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this PORT-GROUP is DELETED also
interface-id: string

Unique ID of the interface

neutron-network-id: string

Neutron network id of this Interface

neutron-network-name: string

Neutron network name of this Interface

interface-role: string

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

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

port-group-id: string

Unique ID for port group in vmware

port-group-name: string

Likely to duplicate value of neutron network name

switch-name: string

DVS or standard switch name (should be non-null for port groups associated with DVS)

orchestration-status: string

Orchestration status of this VNF, mastered by MSO

heat-stack-id: string

Heat stack id corresponding to this instance, managed by MSO

mso-catalog-key: string

Corresponds to the SDN-C catalog id used to configure this VCE

cvlan-tags: object[]
relationship-list: object[]

port-groups: object

port-group: object[]

project: object

describes the project

  • TO service-instance( project Uses 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[]

projects: object

Collection of projects

project: object[]

properties: object

Property holder for query properties or instance properties

property-name: string
property-value: string

property-constraint: object

TBD

  • TO named-query-element (PARENT of property-constraint, property-constraint BelongsTo named-query-element, MANY2ONE)(4)
  • (4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
property-constraint-uuid: string
constraint-type: string
property-name: string
property-value: string
resource-version: string

property-constraints: object

property-constraint: object[]

pserver: object

Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.

  • TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
  • TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
  • TO complex( pserver LocatedIn complex, MANY2ONE)
  • TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
  • TO zone( pserver LocatedIn zone, MANY2ONE)
  • FROM flavor( flavor CanBeInstantiatedIn pserver, MANY2MANY)
  • HPA Capacity getting the compute nodes from given flavor

  • FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
  • FROM hpa-capacity (CHILD of pserver, hpa-capacity BelongsTo pserver, MANY2ONE)
  • HPA Capacity KV for given compute node(1)

  • FROM lag-interface (CHILD of pserver, lag-interface BindsTo pserver, MANY2ONE)(1)
  • FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
  • FROM nos-server( nos-server HostedOn pserver, ONE2ONE)
  • FROM p-interface (CHILD of pserver, p-interface BindsTo pserver, MANY2ONE)(1)
  • FROM vserver( vserver HostedOn pserver, MANY2ONE)
  • (1) IF this PSERVER node is deleted, this FROM node is DELETED also
  • PSERVER cannot be deleted if related to GROUP-ASSIGNMENT,GENERIC-VNF,LOGICAL-LINK,NOS-SERVER,VSERVER
hostname: string

Value from executing hostname on the compute node.

ptnii-equip-name: string

PTNII name

number-of-cpus: integer

Number of cpus

disk-in-gigabytes: integer

Disk size, in GBs

ram-in-megabytes: integer

RAM size, in MBs

equip-type: string

Equipment type. Source of truth should define valid values.

equip-vendor: string

Equipment vendor. Source of truth should define valid values.

equip-model: string

Equipment model. Source of truth should define valid values.

fqdn: string

Fully-qualified domain name

pserver-selflink: string

URL to endpoint where AAI can get more details

ipv4-oam-address: string

Used to configure device, also used for troubleshooting and is IP used for traps generated by device.

serial-number: string

Serial number, may be queried

ipaddress-v4-loopback-0: string

IPV4 Loopback 0 address

ipaddress-v6-loopback-0: string

IPV6 Loopback 0 address

ipaddress-v4-aim: string

IPV4 AIM address

ipaddress-v6-aim: string

IPV6 AIM address

ipaddress-v6-oam: string

IPV6 OAM address

inv-status: string

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

pserver-id: string

ID of Pserver

internet-topology: string

internet topology of Pserver

in-maint: boolean

used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

pserver-name2: string

alternative pserver name

purpose: string

purpose of pserver

prov-status: string

Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]

management-option: string

Indicates who owns and or manages the device.

host-profile: string

The host profile that defines the configuration of the pserver.

relationship-list: object[]
p-interfaces: object[]
lag-interfaces: object[]
hpa-capacity: object[]

pservers: object

Collection of compute hosts.

pserver: object[]

query-parameters: object

QueryParameters for performing a named-query or model query

named-query: object
overloaded-model: object

relationship: object

related-to: string

A keyword provided by A&AI to indicate type of node.

relationship-label: string

The edge label for this relationship.

related-link: string

URL to the object in A&AI.

relationship-data: object[]

relationship-data: 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[]

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

result-data: object

resource-type: string

The specific type of node in the A&AI graph

resource-link: string

The URL to the specific resource

route-table-reference: object

Openstack route table reference.

  • FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
route-table-reference-id: string

Route Table Reference id, UUID assigned to this instance.

route-table-reference-fqdn: string

FQDN entry in the route table.

resource-version: string

Concurrency value

relationship-list: object[]

route-table-references: object

Collection of openstack route table references

route-table-reference: object[]

route-target: object

Route target information

  • TO vpn-binding (PARENT of route-target, route-target BelongsTo vpn-binding, MANY2ONE)(4)
  • (4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
global-route-target: string

Number used to identify an RT, globally unique in the network

route-target-role: string

Role assigned to this route target

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]

route-targets: object

Collection of route target information

route-target: object[]

routing-instance: object

  • TO site-pair-set (PARENT of routing-instance, routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
  • FROM site-pair (CHILD of routing-instance, site-pair BelongsTo routing-instance, MANY2ONE)(1)
  • (1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
routing-instance-id: string

Unique id of routing instance

rpm-owner: string

rpm owner

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

site-pairs: object[]
relationship-list: object[]

routing-instances: object

set of probes related to generic-vnf routing instance

routing-instance: object[]

sdn-zone-response: object

oam-networks: object
az-and-dvs-switches: object[]

sdwan-vpn: object

Instance of an sdwan-vpn

  • TO ext-aai-network( sdwan-vpn BelongsTo ext-aai-network, MANY2MANY)
  • For CCVPN Usecase(2)

  • TO service-instance( sdwan-vpn PartOf service-instance, ONE2MANY)
  • For CCVPN Usecase

  • TO tenant( sdwan-vpn PartOf tenant, ONE2MANY)
  • For CCVPN Usecase

  • TO vpn-binding( sdwan-vpn PartOf vpn-binding, ONE2MANY)
  • For CCVPN Usecase

  • (2) IF this SDWAN-VPN node is deleted, this TO node is DELETED also
sdwan-vpn-id: string

Uniquely identifies this sdwan-vpn by id

sdwan-vpn-name: string

Store the name of this sdwan-vpn.

vxlan-id: string

Store the vxlan-id of this sdwan-vpn.

topology: string

Store the topology of this sdwan-vpn.

tenant-id: string

Store the tenant-id of this sdwan-vpn.

vpn-id: string

Store the vpn-id of this sdwan-vpn.

selflink: string

Store the link to get more information for this object.

operational-status: string

Store the operational-status for this object.

model-customization-id: string

Store the model-customization-id for this object.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]

sdwan-vpns: object

Collection of sdwan-vpns

sdwan-vpn: object[]

search-results: object

result-data: object[]

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

segmentation-assignment: object

Openstack segmentation assignment.

  • TO l3-network (PARENT of segmentation-assignment, segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
  • (4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
segmentation-id: string

Route Table Reference id, UUID assigned to this instance.

resource-version: string

Concurrency value

relationship-list: object[]

segmentation-assignments: object

Collection of openstack segmentation assignments

segmentation-assignment: object[]

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

service-capabilities: object

Collection of service capabilities.

service-capability: object[]

service-capability: object

Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.

  • FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
  • FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
  • SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
service-type: string

This gets defined by others to provide a unique ID for the service, we accept what is sent.

vnf-type: string

String capturing type of vnf, that was intended to identify the 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[]

service-design-and-creation: object

Namespace for objects managed by ASDC

vnf-images: object[]
services: object[]
service-capabilities: object[]
models: object[]
named-queries: object[]

service-instance: object

Instance of a service

  • TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
  • TO collection( service-instance ComposedOf collection, ONE2ONE)
  • TO configuration( service-instance Uses configuration, ONE2MANY)
  • TO configuration( service-instance ComposedOf configuration, MANY2MANY)
  • TO connector( service-instance Uses connector, MANY2MANY)
  • TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
  • TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
  • TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
  • TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
  • TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
  • TO logical-link( service-instance Uses logical-link, MANY2MANY)(2)
  • TO owning-entity( service-instance BelongsTo owning-entity, MANY2ONE)
  • TO pnf( service-instance ComposedOf pnf, ONE2MANY)
  • TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
  • TO service-subscription (PARENT of service-instance, service-instance BelongsTo service-subscription, MANY2ONE)(4)
  • TO vce( service-instance ComposedOf vce, ONE2MANY)
  • TO vlan( service-instance ComposedOf vlan, ONE2MANY)
  • TO zone( service-instance LocatedIn zone, MANY2ONE)
  • FROM allotted-resource (CHILD of service-instance, allotted-resource BelongsTo service-instance, MANY2ONE)(1)
  • FROM connectivity( connectivity PartOf service-instance, ONE2MANY)
  • For CCVPN Usecase

  • FROM device( device PartOf service-instance, ONE2MANY)
  • For CCVPN Usecase

  • FROM forwarding-path( forwarding-path AppliesTo service-instance, MANY2ONE)(1)
  • FROM lan-port-config( lan-port-config PartOf service-instance, ONE2MANY)
  • For CCVPN Usecase

  • FROM metadatum (CHILD of service-instance, metadatum BelongsTo service-instance, MANY2ONE)(1)
  • FROM project( project Uses service-instance, ONE2MANY)
  • FROM sdwan-vpn( sdwan-vpn PartOf service-instance, ONE2MANY)
  • For CCVPN Usecase

  • FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
  • FROM site-resource( site-resource PartOf service-instance, MANY2MANY)
  • For CCVPN Usecase

  • FROM sp-partner( sp-partner PartOf service-instance, ONE2MANY)
  • For CCVPN Usecase

  • FROM wan-port-config( wan-port-config PartOf service-instance, MANY2MANY)
  • For CCVPN Usecase

  • (1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
  • (2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
  • (4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
service-instance-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.

created-at: string

create time of Network Service.

updated-at: string

last update of Network Service.

description: string

short description for service-instance.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

persona-model-version: string

the ASDC model version for this resource or service model.

widget-model-id: string

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

widget-model-version: string

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

bandwidth-total: string

Indicates the total bandwidth to be used for this service.

vhn-portal-url: string

URL customers will use to access the vHN Portal.

service-instance-location-id: string

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

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

selflink: string

Path to the controller object.

orchestration-status: string

Orchestration status of this service.

input-parameters: string

String capturing request parameters from SO to pass to Closed Loop.

relationship-list: object[]
metadata: object[]
allotted-resources: object[]

service-instances: object

Collection of service instances

service-instance: object[]

service-subscription: object

Object that group service instances.

  • TO customer (PARENT of service-subscription, service-subscription BelongsTo customer, MANY2ONE)(4)
  • TO tenant( service-subscription Uses tenant, MANY2MANY)
  • FROM service-instance (CHILD of service-subscription, service-instance BelongsTo service-subscription, MANY2ONE)(1)
  • (1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
service-type: string

Value defined by orchestration to identify this service across 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[]
relationship-list: object[]

service-subscriptions: object

Collection of objects that group service instances.

service-subscription: object[]

services: object

Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.

service: object[]

site-pair: object

  • TO routing-instance (PARENT of site-pair, site-pair BelongsTo routing-instance, MANY2ONE)(4)
  • FROM class-of-service (CHILD of site-pair, class-of-service BelongsTo site-pair, MANY2ONE)(1)
  • (1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this SITE-PAIR is DELETED also
site-pair-id: string

unique identifier of probe

source-ip: string

Prefix address

destination-ip: string

Prefix address

ip-version: string

ip version, v4, v6

destination-hostname: string

Hostname of the destination equipment to which SLAs are measured against.

destination-equip-type: string

The type of destinatination equipment. Could be Router, UCPE, etc.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

classes-of-service: object[]
relationship-list: object[]

site-pair-set: object

Set of instances for probes used to measure service level agreements

  • TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
  • FROM routing-instance (CHILD of site-pair-set, routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
  • (1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
site-pair-set-id: string

Unique id of site pair set.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

routing-instances: object[]
relationship-list: object[]

site-pair-sets: object

Collection of sets of instances for probes related to generic-vnf

site-pair-set: object[]

site-pairs: object

probe within a set

site-pair: object[]

site-resource: object

Instance of a site-resource

  • TO allotted-resource( site-resource Uses allotted-resource, MANY2MANY)
  • For CCVPN Usecase

  • TO complex( site-resource Uses complex, MANY2MANY)
  • For CCVPN Usecase

  • TO ext-aai-network( site-resource BelongsTo ext-aai-network, MANY2MANY)
  • For CCVPN Usecase(2)

  • TO service-instance( site-resource PartOf service-instance, MANY2MANY)
  • For CCVPN Usecase

  • (2) IF this SITE-RESOURCE node is deleted, this TO node is DELETED also
site-resource-id: string

Uniquely identifies this site-resource by id

site-resource-name: string

Store the name of this site-resource.

description: string

Store the description of this site-resource.

type: string

Store the type of this site-resource.

role: string

Store the role of this site-resource.

generated-site-id: string

Store the generated-site-id of this site-resource.

selflink: string

Store the link to get more information for this object.

operational-status: string

Store the operational-status for this object.

model-customization-id: string

Store the model-customization-id for this object.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]

site-resources: object

Collection of site-resources

site-resource: object[]

snapshot: object

Openstack snapshot

  • TO cloud-region (PARENT of snapshot, snapshot BelongsTo cloud-region, MANY2ONE)
  • FROM vserver( vserver Uses snapshot, ONE2ONE)
snapshot-id: string

Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

snapshot-name: string

Snapshot name

snapshot-architecture: string

Operating system architecture

snapshot-os-distro: string

The common name of the operating system distribution in lowercase

snapshot-os-version: string

The operating system version as specified by the distributor.

application: string

The application that the image instantiates.

application-vendor: string

The vendor of the application.

application-version: string

The version of the application.

snapshot-selflink: string

URL to endpoint where AAI can get more details

prev-snapshot-id: string

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

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]

snapshots: object

Collection of openstack snapshots

snapshot: object[]

software-version: object

Software Version

  • TO pnf (PARENT of software-version, software-version BelongsTo pnf, MANY2ONE)
software-version-id: string

Identifier of the software version

is-active-sw-ver: boolean

used to indicate whether or not this software-version is the active one (activeSw = true)

software-versions: object

Collection of software versions.

software-version: object[]

sp-partner: object

Instance of an sp-partner

  • TO service-instance( sp-partner PartOf service-instance, ONE2MANY)
  • For CCVPN Usecase

sp-partner-id: string

Uniquely identifies this sp-partner by id

url: string

Store the URL of this sp-partner.

callsource: string

Store the callsource of this sp-partner.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

operational-status: string

Store the operational-status for this sp-partner.

model-customization-id: string

Store the model-customization-id for this sp-partner.

model-invariant-id: string

the ASDC model id for this sp-partner model.

model-version-id: string

the ASDC model version for this sp-partner model.

relationship-list: object[]

sp-partners: object

Collection of sp-partners

sp-partner: object[]

sriov-pf: object

SR-IOV Physical Function

  • TO p-interface (PARENT of sriov-pf, sriov-pf BelongsTo p-interface, ONE2ONE)(4)
  • FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
  • (4) IF this TO node is deleted, this SRIOV-PF is DELETED also
pf-pci-id: string

Identifier for the sriov-pf

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]

sriov-pfs: object

Collection of SR-IOV Physical Functions.

sriov-pf: object[]

sriov-vf: object

SR-IOV Virtual Function (not to be confused with virtual network function)

  • TO l-interface (PARENT of sriov-vf, sriov-vf BelongsTo l-interface, ONE2ONE)(4)
  • TO sriov-pf( sriov-vf Uses sriov-pf, MANY2ONE)
  • (4) IF this TO node is deleted, this SRIOV-VF is DELETED also
pci-id: string

PCI ID used to identify the sriov-vf

vf-vlan-filter: string

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

vf-mac-filter: string

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

vf-vlan-strip: boolean

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

vf-vlan-anti-spoof-check: boolean

This option ensures anti VLAN spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.

vf-mac-anti-spoof-check: boolean

This option ensures anti MAC spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.

vf-mirrors: string

This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.

vf-broadcast-allow: boolean

This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM

vf-unknown-multicast-allow: boolean

This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM

vf-unknown-unicast-allow: boolean

This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM

vf-insert-stag: boolean

This option, if set to true, instructs to insert outer tag after traffic comes out of VM.

vf-link-status: string

This option is used to set the link status. Valid values as of 1607 are on, off, and auto.

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

sriov-vfs: object

Collection of SR-IOV Virtual Functions.

sriov-vf: object[]

start-node-filter: object

property-name: string
property-value: string

subnet: object

  • TO l3-network (PARENT of subnet, subnet BelongsTo l3-network, MANY2ONE)(4)
  • FROM host-route (CHILD of subnet, host-route BelongsTo subnet, MANY2ONE)(1)
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
  • FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
  • FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
  • (1) IF this SUBNET node is deleted, this FROM node is DELETED also
  • (4) IF this TO node is deleted, this SUBNET is DELETED also
  • SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
subnet-id: string

Subnet ID, should be UUID.

subnet-name: string

Name associated with the subnet.

neutron-subnet-id: string

Neutron id of this subnet

gateway-address: string

gateway ip address

network-start-address: string

network start address

cidr-mask: string

cidr mask

ip-version: string

ip version

orchestration-status: string

Orchestration status of this VNF, mastered by MSO

dhcp-enabled: boolean

dhcp enabled

dhcp-start: string

the start address reserved for use by dhcp

dhcp-end: string

the last address reserved for use by dhcp

subnet-role: string

role of the subnet, referenced when assigning IPs

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[]
relationship-list: object[]

subnets: object

subnet: object[]

tagged-inventory-item-list: object

inventory-item: object[]

tenant: object

Openstack tenant

  • TO cloud-region (PARENT of tenant, tenant BelongsTo cloud-region, MANY2ONE)
  • TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
  • TO l3-network( tenant Uses l3-network, MANY2MANY)
  • TO volume-group( tenant DependsOn volume-group, ONE2MANY)
  • FROM nos-server (CHILD of tenant, nos-server BelongsTo tenant, MANY2ONE)
  • FROM sdwan-vpn( sdwan-vpn PartOf tenant, ONE2MANY)
  • For CCVPN Usecase

  • FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
  • FROM vserver (CHILD of tenant, vserver BelongsTo tenant, MANY2ONE)
  • TENANT cannot be deleted if related to NOS-SERVER,VSERVER
tenant-id: string

Unique id relative to the cloud-region.

tenant-name: string

Readable name of tenant

tenant-context: string

This field will store the tenant context.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

vservers: object[]
nos-servers: object[]
relationship-list: object[]

tenants: object

Collection of openstack tenants.

tenant: object[]

tunnel-xconnect: object

Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted

  • TO allotted-resource (PARENT of tunnel-xconnect, tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
  • (4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
id: string

Allotted Resource id UUID assigned to this instance.

resource-version: string

Concurrency value

relationship-list: object[]

tunnel-xconnects: object

This object is used to store the specific tunnel cross connect aspects of an allotted resource

tunnel-xconnect: object[]

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[]
action: object[]

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( vce Uses availability-zone, MANY2MANY)
  • TO complex( vce LocatedIn complex, MANY2MANY)
  • TO vserver( vce HostedOn vserver, ONE2MANY)
  • FROM entitlement (CHILD of vce, entitlement BelongsTo vce, MANY2ONE)(1)
  • FROM license (CHILD of vce, license BelongsTo vce, MANY2ONE)(1)
  • FROM port-group (CHILD of vce, port-group BelongsTo vce, MANY2ONE)(1)
  • FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
  • (1) IF this VCE node is deleted, this FROM node is DELETED also
vnf-id: string

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

vnf-name: string

Name of VNF.

vnf-name2: string

Alternate name of VNF.

vnf-type: string

String capturing type of vnf, that was intended to identify the 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[]
licenses: object[]
entitlements: object[]
relationship-list: object[]

vces: object

Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.

vce: object[]
vce

vf-module: object

a deployment unit of VNFCs

  • TO generic-vnf (PARENT of vf-module, vf-module BelongsTo generic-vnf, MANY2ONE)(4)
  • TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
  • TO vnfc( vf-module Uses vnfc, ONE2MANY)(2)
  • TO volume-group( vf-module Uses volume-group, ONE2ONE)
  • TO vserver( vf-module Uses vserver, ONE2MANY)
  • (2) IF this VF-MODULE node is deleted, this TO node is DELETED also
  • (4) IF this TO node is deleted, this VF-MODULE is DELETED also
vf-module-id: string

Unique ID of vf-module.

vf-module-name: string

Name of vf-module

heat-stack-id: string

Heat stack id corresponding to this instance.

orchestration-status: string

orchestration status of this vf-module, mastered by MSO

is-base-vf-module: boolean

used to indicate whether or not this object is base vf module

automated-assignment: boolean

Indicates whether vf-module assignment was done via automation or manually

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

persona-model-version: string

the ASDC model version for this resource or service model.

model-customization-id: string

captures the id of all the configuration used to customize the resource for the service.

widget-model-id: string

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

widget-model-version: string

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

contrail-service-instance-fqdn: string

the Contrail unique ID for a service-instance

module-index: integer

the index will track the number of modules of a given type that have been deployed in a VNF, starting with 0, and always choosing the lowest available digit

selflink: string

Path to the controller object.

relationship-list: object[]

vf-modules: object

Collection of vf-modules, a deployment unit of VNFCs

vf-module: object[]

vig-server: object

vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607

  • TO ipsec-configuration (PARENT of vig-server, vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
  • (4) IF this TO node is deleted, this VIG-SERVER is DELETED also
vig-address-type: string

indicates whether the VIG is for AVPN or INTERNET

ipaddress-v4-vig: string

v4 IP of the vig server

ipaddress-v6-vig: string

v6 IP of the vig server

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]

vig-servers: object

vig-server: object[]

vip-ipv4-address-list: object

IPv4 Address Range

  • TO cloud-region (PARENT of vip-ipv4-address-list, vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
  • TO cp( vip-ipv4-address-list Uses cp, MANY2MANY)
  • TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
  • TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
  • FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
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[]

vip-ipv6-address-list: object

IPv6 Address Range

  • TO cloud-region (PARENT of vip-ipv6-address-list, vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
  • TO cp( vip-ipv6-address-list Uses cp, MANY2MANY)
  • TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
  • TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
  • FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
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[]

virtual-data-center: object

Virtual organization of cloud infrastructure elements in a data center context

  • FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
  • FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
  • FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
vdc-id: string

Unique ID of the vdc

vdc-name: string

Name of the virtual data center

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]

virtual-data-centers: object

Virtual organization of cloud infrastructure elements in a data center context

virtual-data-center: object[]

vlan: object

Definition of vlan

  • TO l-interface (PARENT of vlan, vlan LinksTo l-interface, MANY2ONE)(4)
  • TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
  • TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
  • FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
  • FROM l3-interface-ipv4-address-list (CHILD of vlan, l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
  • FROM l3-interface-ipv6-address-list (CHILD of vlan, l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
  • FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
  • (1) IF this VLAN node is deleted, this FROM node is DELETED also
  • (2) IF this VLAN node is deleted, this TO node is DELETED also
  • (4) IF this TO node is deleted, this VLAN is DELETED also
vlan-interface: string

String that identifies the interface

vlan-id-inner: integer

Inner VLAN tag

vlan-id-outer: integer

Outer VLAN tag

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

speed-value: string

Captures the numeric part of the speed

speed-units: string

Captures the units corresponding to the speed

vlan-description: string

Used to describe (the service associated with) the vlan

backdoor-connection: string

Whether customer is going to use this VLAN for backdoor connection to another customer premise device.

vpn-key: string

This indicates the customers VPN ID associated with this vlan

orchestration-status: string

Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.

in-maint: boolean

used to indicate whether or not this object is in maintenance mode (maintenance mode = true)

prov-status: string

Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].

is-ip-unnumbered: boolean

Flag indicating the interface uses the IP Unnumbered configuration.

is-private: boolean

Private VLAN indicator.

relationship-list: object[]
l3-interface-ipv4-address-list: object[]
l3-interface-ipv6-address-list: object[]

vlan-mapping: object

vlan-mapping object is an optional child object of the forwarder-evc object. A given forwarder-evc object may have multiple vlan-mapping objects.

  • TO forwarder-evc (PARENT of vlan-mapping, vlan-mapping BelongsTo forwarder-evc, MANY2ONE)(4)
  • (4) IF this TO node is deleted, this VLAN-MAPPING is DELETED also
vlan-mapping-id: string

Key for vlan-mapping object.

uni-cvlan: string

CVLAN value from the UNI/ingress side of the SAREA gateway access device.

nni-svlan: string

SVLAN value from the NNI/egress side of the SAREA gateway access device.

nni-cvlan: string

CVLAN value from the NNI/egress side of the SAREA gateway access device.

ivlan: string

The internal VLAN ('IVLAN') value. Specific to Arista devices.

resource-version: string
relationship-list: object[]

vlan-mappings: object

Collection of vlan mappings.

vlan-mapping: object[]

vlan-tag: object

  • TO cloud-region( vlan-tag BelongsTo cloud-region, MANY2ONE)
  • TO cp( vlan-tag Uses cp, MANY2MANY)
  • TO l3-network( vlan-tag BelongsTo l3-network, MANY2MANY)
vlan-tag-id: string

Unique ID of the vlan-tag

vlan-tag-role: string

purpose (l3-network to be connected to)

vlan-id-inner: integer

VLAN inner id

vlan-id-outer: integer

VLAN outer id

is-private: boolean

is VLAN private?

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]

vlan-tags: object

vlan-tag: object[]

vlans: object

vlan: object[]

vnf: object

Abstract vnf class

vnf-id: string

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

vnf-image: object

Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.

  • FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
  • VNF-IMAGE cannot be deleted if related to GENERIC-VNF
vnf-image-uuid: string

Unique ID of this asset

application: string

The application that the image instantiates.

application-vendor: string

The vendor of the application.

application-version: string

The version of the application.

selflink: string

URL to endpoint where AAI can get more details

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]

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

vnfc: object

  • TO cp (PARENT of vnfc, vnfc BelongsTo cp, ONE2MANY)
  • cp is child of vnfc(2)

  • TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
  • TO instance-group( vnfc MemberOf instance-group, MANY2MANY)
  • TO vip-ipv4-address-list( vnfc Uses vip-ipv4-address-list, MANY2MANY)
  • TO vip-ipv6-address-list( vnfc Uses vip-ipv6-address-list, MANY2MANY)
  • TO vserver( vnfc HostedOn vserver, ONE2MANY)
  • FROM configuration( configuration Uses vnfc, ONE2ONE)(1)
  • FROM l3-interface-ipv4-address-list (CHILD of vnfc, l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(1)
  • FROM l3-interface-ipv6-address-list (CHILD of vnfc, l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(1)
  • FROM vf-module( vf-module Uses vnfc, ONE2MANY)(3)
  • (1) IF this VNFC node is deleted, this FROM node is DELETED also
  • (2) IF this VNFC node is deleted, this TO node is DELETED also
  • (3) IF this FROM node is deleted, this VNFC is DELETED also
  • (4) IF this TO node is deleted, this VNFC is DELETED also
vnfc-name: string

Unique ID of vnfc.

nfc-naming-code: string

Short code that is used in naming instances of the item being modeled

nfc-function: string

English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service

prov-status: string

prov status of this vnfc

orchestration-status: string

Orchestration status of this VNF, mastered by APP-C

ipaddress-v4-oam-vip: string

Oam V4 vip address of this vnfc

in-maint: boolean

used to indicate whether or not this object is in maintenance mode (maintenance mode = true)

is-closed-loop-disabled: boolean

used to indicate whether closed loop function is enabled on this node

group-notation: string

Group notation of VNFC

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

model-customization-id: string

captures the id of all the configuration used to customize the resource for the service.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]
cps: object[]
cp
l3-interface-ipv4-address-list: object[]
l3-interface-ipv6-address-list: object[]

vnfcs: object

virtual network components associated with a vserver from application controller.

vnfc: object[]

volume: object

Ephemeral Block storage volume.

  • FROM vserver (PARENT of volume, vserver AttachesTo volume, ONE2MANY)(3)
  • (3) IF this FROM node is deleted, this VOLUME is DELETED also
volume-id: string

Unique ID of block storage volume relative to the vserver.

volume-selflink: string

URL to endpoint where AAI can get more details

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]

volume-group: object

Persistent block-level storage.

  • TO cloud-region (PARENT of volume-group, volume-group BelongsTo cloud-region, MANY2ONE)
  • TO complex( volume-group LocatedIn complex, MANY2ONE)
  • FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
  • FROM tenant( tenant DependsOn volume-group, ONE2MANY)
  • FROM vf-module( vf-module Uses volume-group, ONE2ONE)
volume-group-id: string

Unique ID of volume-group.

volume-group-name: string

Name of the volume group.

heat-stack-id: string

Heat stack id corresponding to this volume-group

vnf-type: string

String capturing type of vnf, that was intended to identify the 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[]

volume-groups: object

Collection of persistent block-level storage.

volume-group: object[]

volumes: object

Collection of ephemeral Block storage volumes.

volume: object[]

vpls-pe: object

VPLS Provider Edge routers.

  • TO complex( vpls-pe LocatedIn complex, MANY2ONE)
  • TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
  • FROM lag-interface (CHILD of vpls-pe, lag-interface BindsTo vpls-pe, MANY2ONE)(1)
  • FROM p-interface (CHILD of vpls-pe, p-interface BindsTo vpls-pe, MANY2ONE)(1)
  • (1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
equipment-name: string
prov-status: string

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

ipv4-oam-address: string

Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).

equipment-role: string

Client should send valid enumerated value, e.g., VPLS-PE.

vlan-id-outer: integer

Temporary location for stag to get to VCE

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]
p-interfaces: object[]
lag-interfaces: object[]

vpls-pes: object

Collection of VPLS Provider Edge routers

vpls-pe: object[]

vpn-binding: object

VPN binding

  • TO customer( vpn-binding Uses customer, MANY2MANY)
  • TO ext-aai-network( vpn-binding BelongsTo ext-aai-network, MANY2MANY)
  • For CCVPN Usecase(2)

  • TO p-interface( vpn-binding BindsTo p-interface, ONE2MANY)
  • For CCVPN Usecase

  • FROM allotted-resource( allotted-resource BelongsTo vpn-binding, MANY2MANY)
  • FROM configuration( configuration Uses vpn-binding, MANY2ONE)
  • FROM connectivity( connectivity PartOf vpn-binding, ONE2MANY)
  • For CCVPN Usecase

  • FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
  • FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
  • FROM network-resource( network-resource Uses vpn-binding, ONE2MANY)
  • For CCVPN Usecase

  • FROM route-target (CHILD of vpn-binding, route-target BelongsTo vpn-binding, MANY2ONE)(1)
  • FROM sdwan-vpn( sdwan-vpn PartOf vpn-binding, ONE2MANY)
  • For CCVPN Usecase

  • (1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also
  • (2) IF this VPN-BINDING node is deleted, this TO node is DELETED also
  • VPN-BINDING cannot be deleted if related to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
vpn-id: string

VPN ID, globally unique within A&AI

vpn-name: string

VPN Name

vpn-platform: string

the platform associated with the VPN example AVPN, Mobility

vpn-type: string

Type of the vpn, should be taken from enumerated/valid values

vpn-region: string

region of customer vpn

customer-vpn-id: string

id for this customer vpn

route-distinguisher: string

Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.

access-provider-id: string

Store the id of the access provider of this vpn.

access-client-id: string

Store the id of the access client of this vpn.

access-topology-id: string

Store the id of the access topology of this vpn.

src-access-node-id: string

Store the id of the src-access-node of this vpn.

src-access-ltp-id: string

Store the id of the src-access-ltp of this vpn.

dst-access-node-id: string

Store the id of the dst-access-node of this vpn.

dst-access-ltp-id: string

Store the id of the dst-access-ltp of this vpn.

operational-status: string

Store the operational-status for this object.

model-customization-id: string

Store the model-customization-id for this object.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

route-targets: object[]
relationship-list: object[]

vpn-bindings: object

vpn-binding: object[]

vserver: object

Virtual Servers, aka virtual machine or VM.

  • TO flavor( vserver Uses flavor, MANY2ONE)
  • TO image( vserver Uses image, MANY2ONE)
  • TO pserver( vserver HostedOn pserver, MANY2ONE)
  • TO snapshot( vserver Uses snapshot, ONE2ONE)
  • TO tenant (PARENT of vserver, vserver BelongsTo tenant, MANY2ONE)
  • TO volume (PARENT of vserver, vserver AttachesTo volume, ONE2MANY)(2)
  • FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
  • FROM l-interface (CHILD of vserver, l-interface BindsTo vserver, MANY2ONE)(1)
  • FROM vce( vce HostedOn vserver, ONE2MANY)
  • FROM vf-module( vf-module Uses vserver, ONE2MANY)
  • FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
  • (1) IF this VSERVER node is deleted, this FROM node is DELETED also
  • (2) IF this VSERVER node is deleted, this TO node is DELETED also
vserver-id: string

Unique identifier for this vserver relative to its tenant

vserver-name: string

Name of vserver

vserver-name2: string

Alternative name of vserver

prov-status: string

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

vserver-selflink: string

URL to endpoint where AAI can get more details

in-maint: boolean

Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.

is-closed-loop-disabled: boolean

Used to indicate whether closed loop function is enabled on this node

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

volumes: object[]
relationship-list: object[]
l-interfaces: object[]

vservers: object

Collection of virtual Servers, aka virtual machines or VMs.

vserver: object[]

wan-port-config: object

Instance of a wan-port-config

  • TO ext-aai-network( wan-port-config BelongsTo ext-aai-network, MANY2MANY)
  • For CCVPN Usecase(2)

  • TO service-instance( wan-port-config PartOf service-instance, MANY2MANY)
  • For CCVPN Usecase

  • (2) IF this WAN-PORT-CONFIG node is deleted, this TO node is DELETED also
wan-port-config-id: string

Uniquely identifies this wan-port-config by id

wan-port-config-name: string

Store the name of this wan-port-config.

device-id: string

Store the id of the device of this wan-port-config.

vlan-id: string

Store the id of the vlan of this wan-port-config.

ip-address: string

Store the ip-address of this wan-port-config.

ipv4-address: string

Store the ipv4-address of this wan-port-config.

ipv6-address: string

Store the ipv6-address of this wan-port-config.

provider-ip-address: string

Store the provider-ip-address of this wan-port-config.

provider-ipv4-address: string

Store the provider-ipv4-address of this wan-port-config.

provider-ipv6-address: string

Store the provider-ipv6-address of this wan-port-config.

input-bandwidth: string

Store the input-bandwidth of this wan-port-config.

output-bandwidth: string

Store the output-bandwidth of this wan-port-config.

description: string

Store the description of this wan-port-config.

port-type: string

Store the port-type of this wan-port-config.

port-number: string

Store the port-number of this wan-port-config.

transport-network-name: string

Store the transport-network-name of this wan-port-config.

device-port-id: string

Store the device-port-id of this wan-port-config.

wan-port-id: string

Store the wan-port-id of this wan-port-config.

selflink: string

Store the link to get more information for this object.

operational-status: string

Store the operational-status for this object.

model-customization-id: string

Store the model-customization-id for this object.

model-invariant-id: string

the ASDC model id for this resource or service model.

model-version-id: string

the ASDC model version for this resource or service model.

resource-version: string

Used for optimistic concurrency. Must be empty on create, valid on update and delete.

relationship-list: object[]

wan-port-configs: object

Collection of wan-port-configs

wan-port-config: object[]

zone: object

A zone is a grouping of assets in a location homing to the same connections into the CBB

  • TO complex( zone LocatedIn complex, MANY2ONE)
  • FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
  • FROM pnf( pnf LocatedIn zone, MANY2ONE)
  • FROM pserver( pserver LocatedIn zone, MANY2ONE)
  • FROM service-instance( service-instance LocatedIn zone, MANY2ONE)
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[]

zones: object

Collection of zones

zone: object[]