openapi: 3.0.0 info: title: Active and Available Inventory REST API description: >2 [Differences versus the previous schema version](apidocs/aai_swagger_v16.diff) 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. contact: {} version: 'v16' servers: - url: https://{defaultHost} variables: defaultHost: default: www.example.com/aai/v16 paths: ? /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship parameters: - name: physical-location-id in: path description: Unique identifier for physical location, e.g., CLLI required: true style: simple schema: type: string - name: target-pe in: path description: The Target provider edge router required: true style: simple schema: type: string - name: availability-zone-name in: path description: Name of the availability zone required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship parameters: - name: physical-location-id in: path description: Unique identifier for physical location, e.g., CLLI required: true style: simple schema: type: string - name: target-pe in: path description: The Target provider edge router required: true style: simple schema: type: string - name: availability-zone-name in: path description: Name of the availability zone required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}: get: tags: - CloudInfrastructure summary: getCloudInfrastructureComplexesComplexCtagPoolsCtagPool description: returns ctag-pool operationId: getCloudInfrastructureComplexesComplexCtagPoolsCtagPool parameters: - name: physical-location-id in: path description: Unique identifier for physical location, e.g., CLLI required: true style: simple schema: type: string - name: target-pe in: path description: The Target provider edge router required: true style: simple schema: type: string - name: availability-zone-name in: path description: Name of the availability zone required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/ctag-pool1' - description: >- A collection of C tags (vlan tags) grouped for a specific purpose. ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPool description: > Create or update an existing ctag-pool. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPool parameters: - name: physical-location-id in: path description: Unique identifier for physical location, e.g., CLLI required: true style: simple schema: type: string - name: target-pe in: path description: The Target provider edge router required: true style: simple schema: type: string - name: availability-zone-name in: path description: Name of the availability zone required: true style: simple schema: type: string requestBody: description: ctag-pool object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/ctag-pool' - description: ctag-pool object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPool description: > Update an existing ctag-pool # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPool parameters: - name: physical-location-id in: path description: Unique identifier for physical location, e.g., CLLI required: true style: simple schema: type: string - name: target-pe in: path description: The Target provider edge router required: true style: simple schema: type: string - name: availability-zone-name in: path description: Name of the availability zone required: true style: simple schema: type: string requestBody: description: ctag-pool object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/ctag-pool2' - description: ctag-pool object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPool description: delete an existing ctag-pool operationId: deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPool parameters: - name: physical-location-id in: path description: Unique identifier for physical location, e.g., CLLI required: true style: simple schema: type: string - name: target-pe in: path description: The Target provider edge router required: true style: simple schema: type: string - name: availability-zone-name in: path description: Name of the availability zone required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools: get: tags: - CloudInfrastructure summary: getCloudInfrastructureComplexesComplexCtagPools description: returns ctag-pools operationId: getCloudInfrastructureComplexesComplexCtagPools parameters: - name: physical-location-id in: path description: Unique identifier for physical location, e.g., CLLI required: true style: simple schema: type: string - name: availability-zone-name in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/ctag-pools1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship: put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureComplexesComplexRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureComplexesComplexRelationshipListRelationship parameters: - name: physical-location-id in: path description: Unique identifier for physical location, e.g., CLLI required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureComplexesComplex.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureComplexesComplex.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureComplexesComplexRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructureComplexesComplexRelationshipListRelationship parameters: - name: physical-location-id in: path description: Unique identifier for physical location, e.g., CLLI required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/complexes/complex/{physical-location-id}: get: tags: - CloudInfrastructure summary: getCloudInfrastructureComplexesComplex description: returns complex operationId: getCloudInfrastructureComplexesComplex parameters: - name: physical-location-id in: path description: Unique identifier for physical location, e.g., CLLI required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/complex1' - description: >- Collection of physical locations that can house cloud-regions. ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureComplexesComplex description: > Create or update an existing complex. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureComplexesComplex parameters: - name: physical-location-id in: path description: Unique identifier for physical location, e.g., CLLI required: true style: simple schema: type: string requestBody: description: complex object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureComplexesComplex.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/complex' - description: complex object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureComplexesComplex.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructureComplexesComplex description: > Update an existing complex # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureComplexesComplex parameters: - name: physical-location-id in: path description: Unique identifier for physical location, e.g., CLLI required: true style: simple schema: type: string requestBody: description: complex object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/complex2' - description: complex object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureComplexesComplex description: delete an existing complex operationId: deleteCloudInfrastructureComplexesComplex parameters: - name: physical-location-id in: path description: Unique identifier for physical location, e.g., CLLI required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/complexes: get: tags: - CloudInfrastructure summary: getCloudInfrastructureComplexes description: returns complexes operationId: getCloudInfrastructureComplexes parameters: - name: physical-location-id in: query description: '' style: form explode: true schema: type: string - name: data-center-code in: query description: '' style: form explode: true schema: type: string - name: complex-name in: query description: '' style: form explode: true schema: type: string - name: identity-url in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/complexes1' - description: Collection of physical locations that can house cloud-regions. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: volume-group-id in: path description: Unique ID of volume-group. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: volume-group-id in: path description: Unique ID of volume-group. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}: get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup description: returns volume-group operationId: getCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: volume-group-id in: path description: Unique ID of volume-group. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/volume-group1' - description: >- Persistent block-level storage. ###### Related Nodes - 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) default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup description: > Create or update an existing volume-group. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: volume-group-id in: path description: Unique ID of volume-group. required: true style: simple schema: type: string requestBody: description: volume-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/volume-group' - description: volume-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup description: > Update an existing volume-group # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: volume-group-id in: path description: Unique ID of volume-group. required: true style: simple schema: type: string requestBody: description: volume-group object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/volume-group2' - description: volume-group object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup description: delete an existing volume-group operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: volume-group-id in: path description: Unique ID of volume-group. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups: get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionVolumeGroups description: returns volume-groups operationId: getCloudInfrastructureCloudRegionsCloudRegionVolumeGroups parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: volume-group-id in: query description: '' style: form explode: true schema: type: string - name: volume-group-name in: query description: '' style: form explode: true schema: type: string - name: heat-stack-id in: query description: '' style: form explode: true schema: type: string - name: vnf-type in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/volume-groups1' - description: Collection of persistent block-level storage. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: volume-id in: path description: Unique ID of block storage volume relative to the vserver. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: volume-id in: path description: Unique ID of block storage volume relative to the vserver. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id} : get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume description: returns volume operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: volume-id in: path description: Unique ID of block storage volume relative to the vserver. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/volume1' - description: >- Ephemeral Block storage volume. ###### Related Nodes - FROM vserver (PARENT of volume, vserver AttachesTo volume, ONE2MANY)(3) -(3) IF this FROM node is deleted, this VOLUME is DELETED also default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume description: > Create or update an existing volume. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: volume-id in: path description: Unique ID of block storage volume relative to the vserver. required: true style: simple schema: type: string requestBody: description: volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/volume' - description: volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume description: > Update an existing volume # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: volume-id in: path description: Unique ID of block storage volume relative to the vserver. required: true style: simple schema: type: string requestBody: description: volume object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/volume2' - description: volume object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume description: delete an existing volume operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: volume-id in: path description: Unique ID of block storage volume relative to the vserver. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes : get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumes description: returns volumes operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumes parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: volume-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/volumes1' - description: Collection of ephemeral Block storage volumes. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-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 : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-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 : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-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} : get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: returns l3-interface-ipv4-address-list operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list1' - description: >- IPv4 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: > Create or update an existing l3-interface-ipv4-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list' - description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: > Update an existing l3-interface-ipv4-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list2' - description: l3-interface-ipv4-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: delete an existing l3-interface-ipv4-address-list operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-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 : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-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} : get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: returns l3-interface-ipv6-address-list operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list1' - description: >- IPv6 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: > Create or update an existing l3-interface-ipv6-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list' - description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: > Update an existing l3-interface-ipv6-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list2' - description: l3-interface-ipv6-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: delete an existing l3-interface-ipv6-address-list operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-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} : get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan description: returns vlan operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan1' - description: >- Definition of vlan ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan description: > Create or update an existing vlan. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string requestBody: description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan' - description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan description: > Update an existing vlan # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string requestBody: description: vlan object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan2' - description: vlan object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan description: delete an existing vlan operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-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 : get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlans description: returns vlans operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlans parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: query description: '' style: form explode: true schema: type: string - name: vlan-id-inner in: query description: '' style: form explode: true schema: type: integer format: int64 - name: vpn-key in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/vlans1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-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 : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-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} : get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf description: returns sriov-vf operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vf1' - description: >- SR-IOV Virtual Function (not to be confused with virtual network function) ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf description: > Create or update an existing sriov-vf. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string requestBody: description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vf' - description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf description: > Update an existing sriov-vf # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string requestBody: description: sriov-vf object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vf2' - description: sriov-vf object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf description: delete an existing sriov-vf operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-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 : get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfs description: returns sriov-vfs operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfs parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: pci-id in: query description: '' style: form explode: true schema: type: string - name: vf-vlan-filter in: query description: '' style: form explode: true schema: type: string - name: vf-mac-filter in: query description: '' style: form explode: true schema: type: string - name: vf-vlan-strip in: query description: '' style: form explode: true schema: type: boolean - name: neutron-network-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vfs1' - description: Collection of SR-IOV Virtual Functions. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-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 : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-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 : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-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} : get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList description: returns l3-interface-ipv4-address-list operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list1' - description: >- IPv4 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList description: > Create or update an existing l3-interface-ipv4-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list' - description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList description: > Update an existing l3-interface-ipv4-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list2' - description: l3-interface-ipv4-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList description: delete an existing l3-interface-ipv4-address-list operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-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 : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-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} : get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList description: returns l3-interface-ipv6-address-list operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list1' - description: >- IPv6 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList description: > Create or update an existing l3-interface-ipv6-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list' - description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList description: > Update an existing l3-interface-ipv6-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list2' - description: l3-interface-ipv6-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList description: delete an existing l3-interface-ipv6-address-list operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name} : get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface description: returns l-interface operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interface1' - description: >- Logical interfaces, e.g., a vnic. ###### Related Nodes - 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 vrf( vrf Uses l-interface, ONE2MANY) - FROM l3-interface-ipv4-address-list (CHILD of l-interface, l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1) - FROM l3-interface-ipv6-address-list (CHILD of l-interface, l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1) - FROM lag-interface( lag-interface Uses l-interface, 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface description: > Create or update an existing l-interface. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string requestBody: description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interface' - description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface description: > Update an existing l-interface # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string requestBody: description: l-interface object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interface2' - description: l-interface object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface description: delete an existing l-interface operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces : get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfaces description: returns l-interfaces operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfaces parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: interface-name in: query description: '' style: form explode: true schema: type: string - name: interface-id in: query description: '' style: form explode: true schema: type: string - name: macaddr in: query description: '' style: form explode: true schema: type: string - name: network-name in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interfaces1' - description: Collection of logical interfaces. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id} : get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver description: returns vserver operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/vserver1' - description: >- Virtual Servers, aka virtual machine or VM. ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver description: > Create or update an existing vserver. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string requestBody: description: vserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/vserver' - description: vserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver description: > Update an existing vserver # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string requestBody: description: vserver object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/vserver2' - description: vserver object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver description: delete an existing vserver operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: path description: Unique identifier for this vserver relative to its tenant required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers: get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVservers description: returns vservers operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVservers parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: vserver-id in: query description: '' style: form explode: true schema: type: string - name: vserver-name in: query description: '' style: form explode: true schema: type: string - name: vserver-name2 in: query description: '' style: form explode: true schema: type: string - name: prov-status in: query description: '' style: form explode: true schema: type: string - name: in-maint in: query description: '' style: form explode: true schema: type: boolean - name: is-closed-loop-disabled in: query description: '' style: form explode: true schema: type: boolean responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/vservers1' - description: Collection of virtual Servers, aka virtual machines or VMs. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantNosServersNosServerRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantNosServersNosServerRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: nos-server-id in: path description: Unique identifier for this nos relative to its tenant required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantNosServersNosServer.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantNosServersNosServer.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantNosServersNosServerRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantNosServersNosServerRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: nos-server-id in: path description: Unique identifier for this nos relative to its tenant required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/nos-servers/nos-server/{nos-server-id} : get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantNosServersNosServer description: returns nos-server operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantNosServersNosServer parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: nos-server-id in: path description: Unique identifier for this nos relative to its tenant required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/nos-server1' - description: >- nos-server is the execution environment that will have images, certain versions of VNOS, running on it. ###### Related Nodes - 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) default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantNosServersNosServer description: > Create or update an existing nos-server. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantNosServersNosServer parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: nos-server-id in: path description: Unique identifier for this nos relative to its tenant required: true style: simple schema: type: string requestBody: description: nos-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantNosServersNosServer.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/nos-server' - description: nos-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantNosServersNosServer.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantNosServersNosServer description: > Update an existing nos-server # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantNosServersNosServer parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: nos-server-id in: path description: Unique identifier for this nos relative to its tenant required: true style: simple schema: type: string requestBody: description: nos-server object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/nos-server2' - description: nos-server object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantNosServersNosServer description: delete an existing nos-server operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantNosServersNosServer parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: nos-server-id in: path description: Unique identifier for this nos relative to its tenant required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/nos-servers: get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantNosServers description: returns nos-servers operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantNosServers parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: nos-server-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/nos-servers1' - description: nos-server is the execution environment that will have images, certain versions of VNOS, running on it. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}: get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenant description: returns tenant operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenant parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/tenant1' - description: >- Openstack tenant ###### Related Nodes - TO cloud-region (PARENT of tenant, tenant BelongsTo cloud-region, MANY2ONE) - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY) - TO l3-network( tenant Uses l3-network, MANY2MANY) - TO volume-group( tenant DependsOn volume-group, ONE2MANY) - FROM generic-vnf( generic-vnf BelongsTo tenant, MANY2ONE) - FROM 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant description: > Create or update an existing tenant. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string requestBody: description: tenant object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/tenant' - description: tenant object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant description: > Update an existing tenant # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string requestBody: description: tenant object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/tenant2' - description: tenant object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenant description: delete an existing tenant operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenant parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: path description: Unique id relative to the cloud-region. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants: get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionTenants description: returns tenants operationId: getCloudInfrastructureCloudRegionsCloudRegionTenants parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: tenant-id in: query description: '' style: form explode: true schema: type: string - name: tenant-name in: query description: '' style: form explode: true schema: type: string - name: tenant-context in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/tenants1' - description: Collection of openstack tenants. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: flavor-id in: path description: Flavor id, expected to be unique across cloud-region. required: true style: simple schema: type: string - name: hpa-capability-id in: path description: UUID to uniquely identify a HPA capability required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: flavor-id in: path description: Flavor id, expected to be unique across cloud-region. required: true style: simple schema: type: string - name: hpa-capability-id in: path description: UUID to uniquely identify a HPA capability required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: flavor-id in: path description: Flavor id, expected to be unique across cloud-region. required: true style: simple schema: type: string - name: hpa-capability-id in: path description: UUID to uniquely identify a HPA capability required: true style: simple schema: type: string - name: hpa-attribute-key in: path description: name of the specific HPA attribute required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: flavor-id in: path description: Flavor id, expected to be unique across cloud-region. required: true style: simple schema: type: string - name: hpa-capability-id in: path description: UUID to uniquely identify a HPA capability required: true style: simple schema: type: string - name: hpa-attribute-key in: path description: name of the specific HPA attribute required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes description: returns hpa-feature-attributes operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: flavor-id in: path description: Flavor id, expected to be unique across cloud-region. required: true style: simple schema: type: string - name: hpa-capability-id in: path description: UUID to uniquely identify a HPA capability required: true style: simple schema: type: string - name: hpa-attribute-key in: path description: name of the specific HPA attribute required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/hpa-feature-attributes1' - description: >- HPA Capability Feature attributes ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes description: > Create or update an existing hpa-feature-attributes. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: flavor-id in: path description: Flavor id, expected to be unique across cloud-region. required: true style: simple schema: type: string - name: hpa-capability-id in: path description: UUID to uniquely identify a HPA capability required: true style: simple schema: type: string - name: hpa-attribute-key in: path description: name of the specific HPA attribute required: true style: simple schema: type: string requestBody: description: hpa-feature-attributes object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/hpa-feature-attributes' - description: hpa-feature-attributes object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes description: > Update an existing hpa-feature-attributes # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: flavor-id in: path description: Flavor id, expected to be unique across cloud-region. required: true style: simple schema: type: string - name: hpa-capability-id in: path description: UUID to uniquely identify a HPA capability required: true style: simple schema: type: string - name: hpa-attribute-key in: path description: name of the specific HPA attribute required: true style: simple schema: type: string requestBody: description: hpa-feature-attributes object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/hpa-feature-attributes2' - description: hpa-feature-attributes object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes description: delete an existing hpa-feature-attributes operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: flavor-id in: path description: Flavor id, expected to be unique across cloud-region. required: true style: simple schema: type: string - name: hpa-capability-id in: path description: UUID to uniquely identify a HPA capability required: true style: simple schema: type: string - name: hpa-attribute-key in: path description: name of the specific HPA attribute required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id} : get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability description: returns hpa-capability operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: flavor-id in: path description: Flavor id, expected to be unique across cloud-region. required: true style: simple schema: type: string - name: hpa-capability-id in: path description: UUID to uniquely identify a HPA capability required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/hpa-capability1' - description: >- Represents a HPA capability ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability description: > Create or update an existing hpa-capability. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: flavor-id in: path description: Flavor id, expected to be unique across cloud-region. required: true style: simple schema: type: string - name: hpa-capability-id in: path description: UUID to uniquely identify a HPA capability required: true style: simple schema: type: string requestBody: description: hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/hpa-capability' - description: hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability description: > Update an existing hpa-capability # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: flavor-id in: path description: Flavor id, expected to be unique across cloud-region. required: true style: simple schema: type: string - name: hpa-capability-id in: path description: UUID to uniquely identify a HPA capability required: true style: simple schema: type: string requestBody: description: hpa-capability object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/hpa-capability2' - description: hpa-capability object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability description: delete an existing hpa-capability operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: flavor-id in: path description: Flavor id, expected to be unique across cloud-region. required: true style: simple schema: type: string - name: hpa-capability-id in: path description: UUID to uniquely identify a HPA capability required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities: get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilities description: returns hpa-capabilities operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilities parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: flavor-id in: path description: Flavor id, expected to be unique across cloud-region. required: true style: simple schema: type: string - name: hpa-capability-id in: query description: '' style: form explode: true schema: type: string - name: hpa-feature in: query description: '' style: form explode: true schema: type: string - name: architecture in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/hpa-capabilities1' - description: Collection of HPA Capabilities default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: flavor-id in: path description: Flavor id, expected to be unique across cloud-region. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: flavor-id in: path description: Flavor id, expected to be unique across cloud-region. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}: get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor description: returns flavor operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: flavor-id in: path description: Flavor id, expected to be unique across cloud-region. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/flavor1' - description: >- Openstack flavor. ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor description: > Create or update an existing flavor. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: flavor-id in: path description: Flavor id, expected to be unique across cloud-region. required: true style: simple schema: type: string requestBody: description: flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/flavor' - description: flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor description: > Update an existing flavor # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: flavor-id in: path description: Flavor id, expected to be unique across cloud-region. required: true style: simple schema: type: string requestBody: description: flavor object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/flavor2' - description: flavor object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor description: delete an existing flavor operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: flavor-id in: path description: Flavor id, expected to be unique across cloud-region. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors: get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionFlavors description: returns flavors operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavors parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: flavor-id in: query description: '' style: form explode: true schema: type: string - name: flavor-name in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/flavors1' - description: Collection of openstack flavors. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: group-id in: path description: Group id, expected to be unique across cloud-region. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: group-id in: path description: Group id, expected to be unique across cloud-region. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}: get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment description: returns group-assignment operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: group-id in: path description: Group id, expected to be unique across cloud-region. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/group-assignment1' - description: >- Openstack group-assignment used to store exclusivity groups (EG). ###### Related Nodes - 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) default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment description: > Create or update an existing group-assignment. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: group-id in: path description: Group id, expected to be unique across cloud-region. required: true style: simple schema: type: string requestBody: description: group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/group-assignment' - description: group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment description: > Update an existing group-assignment # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: group-id in: path description: Group id, expected to be unique across cloud-region. required: true style: simple schema: type: string requestBody: description: group-assignment object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/group-assignment2' - description: group-assignment object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment description: delete an existing group-assignment operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: group-id in: path description: Group id, expected to be unique across cloud-region. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments: get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignments description: returns group-assignments operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignments parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: group-id in: query description: '' style: form explode: true schema: type: string - name: group-type in: query description: '' style: form explode: true schema: type: string - name: group-name in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/group-assignments1' - description: Collection of openstack group assignments default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: snapshot-id in: path description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: snapshot-id in: path description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}: get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot description: returns snapshot operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: snapshot-id in: path description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/snapshot1' - description: >- Openstack snapshot ###### Related Nodes - TO cloud-region (PARENT of snapshot, snapshot BelongsTo cloud-region, MANY2ONE) - FROM vserver( vserver Uses snapshot, ONE2ONE) default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot description: > Create or update an existing snapshot. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: snapshot-id in: path description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. required: true style: simple schema: type: string requestBody: description: snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/snapshot' - description: snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot description: > Update an existing snapshot # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: snapshot-id in: path description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. required: true style: simple schema: type: string requestBody: description: snapshot object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/snapshot2' - description: snapshot object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot description: delete an existing snapshot operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: snapshot-id in: path description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots: get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionSnapshots description: returns snapshots operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshots parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: snapshot-id in: query description: '' style: form explode: true schema: type: string - name: snapshot-name in: query description: '' style: form explode: true schema: type: string - name: application in: query description: '' style: form explode: true schema: type: string - name: application-vendor in: query description: '' style: form explode: true schema: type: string - name: application-version in: query description: '' style: form explode: true schema: type: string - name: prev-snapshot-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/snapshots1' - description: Collection of openstack snapshots default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: image-id in: path description: Image id, expected to be unique across cloud region required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: image-id in: path description: Image id, expected to be unique across cloud region required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname} : get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum description: returns metadatum operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: image-id in: path description: Image id, expected to be unique across cloud region required: true style: simple schema: type: string - name: metaname in: path description: '' required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/metadatum' - description: >- Key/value pairs ###### Related Nodes - TO configuration (PARENT of metadatum, metadatum BelongsTo configuration, MANY2ONE)(4) - TO connector (PARENT of metadatum, metadatum BelongsTo connector, MANY2ONE)(4) - TO cp( metadatum AppliesTo cp, MANY2MANY) AAI-2154 For BBS Usecase - TO generic-vnf( metadatum AppliesTo generic-vnf, MANY2MANY) AAI-2154 For BBS Usecase - TO image (PARENT of metadatum, metadatum BelongsTo image, MANY2ONE)(4) - TO model-ver (PARENT of metadatum, metadatum BelongsTo model-ver, MANY2ONE)(4) - TO pnf( metadatum AppliesTo pnf, MANY2MANY) AAI-2154 For BBS Usecase - TO service-instance (PARENT of metadatum, metadatum BelongsTo service-instance, MANY2ONE)(4) -(4) IF this TO node is deleted, this METADATUM is DELETED also default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum description: > Create or update an existing metadatum. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: image-id in: path description: Image id, expected to be unique across cloud region required: true style: simple schema: type: string - name: metaname in: path description: '' required: true style: simple schema: type: string requestBody: description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/metadatum' - description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum description: > Update an existing metadatum # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: image-id in: path description: Image id, expected to be unique across cloud region required: true style: simple schema: type: string - name: metaname in: path description: '' required: true style: simple schema: type: string requestBody: description: metadatum object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/metadatum2' - description: metadatum object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum description: delete an existing metadatum operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: image-id in: path description: Image id, expected to be unique across cloud region required: true style: simple schema: type: string - name: metaname in: path description: '' required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata: get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadata description: returns metadata operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadata parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: image-id in: path description: Image id, expected to be unique across cloud region required: true style: simple schema: type: string - name: metaname in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/metadata' - description: Collection of metadatum (key/value pairs) default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}: get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionImagesImage description: returns image operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImage parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: image-id in: path description: Image id, expected to be unique across cloud region required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/image1' - description: >- Openstack image. ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage description: > Create or update an existing image. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: image-id in: path description: Image id, expected to be unique across cloud region required: true style: simple schema: type: string requestBody: description: image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/image' - description: image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage description: > Update an existing image # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: image-id in: path description: Image id, expected to be unique across cloud region required: true style: simple schema: type: string requestBody: description: image object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/image2' - description: image object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImage description: delete an existing image operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImage parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: image-id in: path description: Image id, expected to be unique across cloud region required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images: get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionImages description: returns images operationId: getCloudInfrastructureCloudRegionsCloudRegionImages parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: image-id in: query description: '' style: form explode: true schema: type: string - name: image-name in: query description: '' style: form explode: true schema: type: string - name: application in: query description: '' style: form explode: true schema: type: string - name: application-vendor in: query description: '' style: form explode: true schema: type: string - name: application-version in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/images1' - description: Collectio of Openstack images. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: switch-name in: path description: DVS switch name required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: switch-name in: path description: DVS switch name required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}: get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch description: returns dvs-switch operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: switch-name in: path description: DVS switch name required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/dvs-switch1' - description: "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. \n###### Related Nodes\n- TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)\n- TO cloud-region (PARENT of dvs-switch, dvs-switch BelongsTo cloud-region, MANY2ONE)" default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch description: > Create or update an existing dvs-switch. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: switch-name in: path description: DVS switch name required: true style: simple schema: type: string requestBody: description: dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/dvs-switch' - description: dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch description: > Update an existing dvs-switch # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: switch-name in: path description: DVS switch name required: true style: simple schema: type: string requestBody: description: dvs-switch object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/dvs-switch2' - description: dvs-switch object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch description: delete an existing dvs-switch operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: switch-name in: path description: DVS switch name required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches: get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitches description: returns dvs-switches operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitches parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: switch-name in: query description: '' style: form explode: true schema: type: string - name: vcenter-url in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/dvs-switches1' - description: Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: network-uuid in: path description: UUID of the network. Unique across a cloud-region required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: network-uuid in: path description: UUID of the network. Unique across a cloud-region required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}: get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork description: returns oam-network operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: network-uuid in: path description: UUID of the network. Unique across a cloud-region required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/oam-network1' - description: "OAM network, to be deprecated shortly. Do not use for new purposes. \n###### Related Nodes\n- TO cloud-region (PARENT of oam-network, oam-network BelongsTo cloud-region, MANY2ONE)\n- TO complex( oam-network AppliesTo complex, MANY2MANY)\n- TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)" default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork description: > Create or update an existing oam-network. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: network-uuid in: path description: UUID of the network. Unique across a cloud-region required: true style: simple schema: type: string requestBody: description: oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/oam-network' - description: oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork description: > Update an existing oam-network # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: network-uuid in: path description: UUID of the network. Unique across a cloud-region required: true style: simple schema: type: string requestBody: description: oam-network object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/oam-network2' - description: oam-network object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork description: delete an existing oam-network operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: network-uuid in: path description: UUID of the network. Unique across a cloud-region required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks: get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionOamNetworks description: returns oam-networks operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworks parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: network-uuid in: query description: '' style: form explode: true schema: type: string - name: network-name in: query description: '' style: form explode: true schema: type: string - name: cvlan-tag in: query description: '' style: form explode: true schema: type: integer format: int64 responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/oam-networks1' - description: Collection of OAM networks, to be deprecated shortly. Do not use for new purposes. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: availability-zone-name in: path description: Name of the availability zone. Unique across a cloud region required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: availability-zone-name in: path description: Name of the availability zone. Unique across a cloud region required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name} : get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone description: returns availability-zone operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: availability-zone-name in: path description: Name of the availability zone. Unique across a cloud region required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/availability-zone1' - description: >- Availability zone, a collection of compute hosts/pservers ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone description: > Create or update an existing availability-zone. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: availability-zone-name in: path description: Name of the availability zone. Unique across a cloud region required: true style: simple schema: type: string requestBody: description: availability-zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/availability-zone' - description: availability-zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone description: > Update an existing availability-zone # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: availability-zone-name in: path description: Name of the availability zone. Unique across a cloud region required: true style: simple schema: type: string requestBody: description: availability-zone object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/availability-zone2' - description: availability-zone object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone description: delete an existing availability-zone operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: availability-zone-name in: path description: Name of the availability zone. Unique across a cloud region required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones: get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZones description: returns availability-zones operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZones parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: availability-zone-name in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/availability-zones1' - description: Collection of availability zones default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship: put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegion.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegion.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: vip-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: vip-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}: get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList description: returns vip-ipv4-address-list operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: vip-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/vip-ipv4-address-list1' - description: >- IPv4 Address Range ###### Related Nodes - 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) default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList description: > Create or update an existing vip-ipv4-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: vip-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: vip-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/vip-ipv4-address-list' - description: vip-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList description: > Update an existing vip-ipv4-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: vip-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: vip-ipv4-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/vip-ipv4-address-list2' - description: vip-ipv4-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList description: delete an existing vip-ipv4-address-list operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: vip-ipv4-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: vip-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: vip-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}: get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList description: returns vip-ipv6-address-list operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: vip-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/vip-ipv6-address-list1' - description: >- IPv6 Address Range ###### Related Nodes - 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) default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList description: > Create or update an existing vip-ipv6-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: vip-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: vip-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/vip-ipv6-address-list' - description: vip-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList description: > Update an existing vip-ipv6-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: vip-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: vip-ipv6-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/vip-ipv6-address-list2' - description: vip-ipv6-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList description: delete an existing vip-ipv6-address-list operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: vip-ipv6-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: hpa-capability-id in: path description: UUID to uniquely identify a HPA capability required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: hpa-capability-id in: path description: UUID to uniquely identify a HPA capability required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: hpa-capability-id in: path description: UUID to uniquely identify a HPA capability required: true style: simple schema: type: string - name: hpa-attribute-key in: path description: name of the specific HPA attribute required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: hpa-capability-id in: path description: UUID to uniquely identify a HPA capability required: true style: simple schema: type: string - name: hpa-attribute-key in: path description: name of the specific HPA attribute required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key} : get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes description: returns hpa-feature-attributes operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: hpa-capability-id in: path description: UUID to uniquely identify a HPA capability required: true style: simple schema: type: string - name: hpa-attribute-key in: path description: name of the specific HPA attribute required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/hpa-feature-attributes1' - description: >- HPA Capability Feature attributes ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes description: > Create or update an existing hpa-feature-attributes. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: hpa-capability-id in: path description: UUID to uniquely identify a HPA capability required: true style: simple schema: type: string - name: hpa-attribute-key in: path description: name of the specific HPA attribute required: true style: simple schema: type: string requestBody: description: hpa-feature-attributes object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/hpa-feature-attributes' - description: hpa-feature-attributes object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes description: > Update an existing hpa-feature-attributes # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: hpa-capability-id in: path description: UUID to uniquely identify a HPA capability required: true style: simple schema: type: string - name: hpa-attribute-key in: path description: name of the specific HPA attribute required: true style: simple schema: type: string requestBody: description: hpa-feature-attributes object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/hpa-feature-attributes2' - description: hpa-feature-attributes object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes description: delete an existing hpa-feature-attributes operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: hpa-capability-id in: path description: UUID to uniquely identify a HPA capability required: true style: simple schema: type: string - name: hpa-attribute-key in: path description: name of the specific HPA attribute required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id} : get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability description: returns hpa-capability operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: hpa-capability-id in: path description: UUID to uniquely identify a HPA capability required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/hpa-capability1' - description: >- Represents a HPA capability ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability description: > Create or update an existing hpa-capability. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: hpa-capability-id in: path description: UUID to uniquely identify a HPA capability required: true style: simple schema: type: string requestBody: description: hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/hpa-capability' - description: hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability description: > Update an existing hpa-capability # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: hpa-capability-id in: path description: UUID to uniquely identify a HPA capability required: true style: simple schema: type: string requestBody: description: hpa-capability object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/hpa-capability2' - description: hpa-capability object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability description: delete an existing hpa-capability operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: hpa-capability-id in: path description: UUID to uniquely identify a HPA capability required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities: get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilities description: returns hpa-capabilities operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilities parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: hpa-capability-id in: query description: '' style: form explode: true schema: type: string - name: hpa-feature in: query description: '' style: form explode: true schema: type: string - name: architecture in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/hpa-capabilities1' - description: Collection of HPA Capabilities default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfoRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfoRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfoRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfoRelationshipListRelationship parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id} : get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo description: returns esr-system-info operationId: getCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/esr-system-info1' - description: >- Persist common address information of external systems. ###### Related Nodes - TO cloud-region (PARENT of esr-system-info, esr-system-info BelongsTo cloud-region, MANY2ONE)(4) - TO esr-ems (PARENT of esr-system-info, esr-system-info BelongsTo esr-ems, MANY2ONE)(4) - TO esr-nfvo (PARENT of esr-system-info, esr-system-info BelongsTo esr-nfvo, ONE2ONE)(4) - TO esr-thirdparty-sdnc (PARENT of esr-system-info, esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4) - TO esr-vnfm (PARENT of esr-system-info, esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4) - FROM ext-aai-network (PARENT of esr-system-info, ext-aai-network Uses esr-system-info, ONE2MANY) For CCVPN Usecase(3) -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also -ESR-SYSTEM-INFO cannot be deleted if related to EXT-AAI-NETWORK default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo description: > Create or update an existing esr-system-info. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string requestBody: description: esr-system-info object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/esr-system-info' - description: esr-system-info object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo description: > Update an existing esr-system-info # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string requestBody: description: esr-system-info object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/esr-system-info2' - description: esr-system-info object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo description: delete an existing esr-system-info operationId: deleteCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list: get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoList description: returns esr-system-info-list operationId: getCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoList parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: esr-system-info-id in: query description: '' style: form explode: true schema: type: string - name: system-name in: query description: '' style: form explode: true schema: type: string - name: system-type in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/esr-system-info-list1' - description: Collection of persistent block-level external system auth info. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}: get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegionsCloudRegion description: returns cloud-region operationId: getCloudInfrastructureCloudRegionsCloudRegion parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/cloud-region1' - description: >- 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. ###### Related Nodes - 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 generic-vnf( generic-vnf LocatedIn 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureCloudRegionsCloudRegion description: > Create or update an existing cloud-region. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegion parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string requestBody: description: cloud-region object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegion.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/cloud-region' - description: cloud-region object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureCloudRegionsCloudRegion.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructureCloudRegionsCloudRegion description: > Update an existing cloud-region # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureCloudRegionsCloudRegion parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string requestBody: description: cloud-region object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/cloud-region2' - description: cloud-region object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureCloudRegionsCloudRegion description: delete an existing cloud-region operationId: deleteCloudInfrastructureCloudRegionsCloudRegion parameters: - name: cloud-owner in: path description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname required: true style: simple schema: type: string - name: cloud-region-id in: path description: Identifier used by the vendor for the region. Second part of composite key required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/cloud-regions: get: tags: - CloudInfrastructure summary: getCloudInfrastructureCloudRegions description: returns cloud-regions operationId: getCloudInfrastructureCloudRegions parameters: - name: cloud-owner in: query description: '' style: form explode: true schema: type: string - name: cloud-region-id in: query description: '' style: form explode: true schema: type: string - name: cloud-type in: query description: '' style: form explode: true schema: type: string - name: owner-defined-type in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/cloud-regions1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship: put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship parameters: - name: nm-profile-name in: path description: Unique name of network profile. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureNetworkProfilesNetworkProfile.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureNetworkProfilesNetworkProfile.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship parameters: - name: nm-profile-name in: path description: Unique name of network profile. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}: get: tags: - CloudInfrastructure summary: getCloudInfrastructureNetworkProfilesNetworkProfile description: returns network-profile operationId: getCloudInfrastructureNetworkProfilesNetworkProfile parameters: - name: nm-profile-name in: path description: Unique name of network profile. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/network-profile1' - description: >- Network profile populated by SDN-GP for SNMP ###### Related Nodes - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY) default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfile description: > Create or update an existing network-profile. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfile parameters: - name: nm-profile-name in: path description: Unique name of network profile. required: true style: simple schema: type: string requestBody: description: network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureNetworkProfilesNetworkProfile.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/network-profile' - description: network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureNetworkProfilesNetworkProfile.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructureNetworkProfilesNetworkProfile description: > Update an existing network-profile # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureNetworkProfilesNetworkProfile parameters: - name: nm-profile-name in: path description: Unique name of network profile. required: true style: simple schema: type: string requestBody: description: network-profile object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/network-profile2' - description: network-profile object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureNetworkProfilesNetworkProfile description: delete an existing network-profile operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfile parameters: - name: nm-profile-name in: path description: Unique name of network profile. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/network-profiles: get: tags: - CloudInfrastructure summary: getCloudInfrastructureNetworkProfiles description: returns network-profiles operationId: getCloudInfrastructureNetworkProfiles parameters: - name: nm-profile-name in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/network-profiles1' - description: Collection of network profiles default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship: put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructurePserversPserverRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserver.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserver.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructurePserversPserverRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship: put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterface.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterface.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pf-pci-id in: path description: Identifier for the sriov-pf required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pf-pci-id in: path description: Identifier for the sriov-pf required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}: get: tags: - CloudInfrastructure summary: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf description: returns sriov-pf operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pf-pci-id in: path description: Identifier for the sriov-pf required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-pf1' - description: >- SR-IOV Physical Function ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf description: > Create or update an existing sriov-pf. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pf-pci-id in: path description: Identifier for the sriov-pf required: true style: simple schema: type: string requestBody: description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-pf' - description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf description: > Update an existing sriov-pf # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pf-pci-id in: path description: Identifier for the sriov-pf required: true style: simple schema: type: string requestBody: description: sriov-pf object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-pf2' - description: sriov-pf object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf description: delete an existing sriov-pf operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pf-pci-id in: path description: Identifier for the sriov-pf required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs: get: tags: - CloudInfrastructure summary: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfs description: returns sriov-pfs operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfs parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pf-pci-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-pfs1' - description: Collection of SR-IOV Physical Functions. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - CloudInfrastructure summary: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: returns l3-interface-ipv4-address-list operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list1' - description: >- IPv4 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: > Create or update an existing l3-interface-ipv4-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list' - description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: > Update an existing l3-interface-ipv4-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list2' - description: l3-interface-ipv4-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: delete an existing l3-interface-ipv4-address-list operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - CloudInfrastructure summary: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: returns l3-interface-ipv6-address-list operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list1' - description: >- IPv6 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: > Create or update an existing l3-interface-ipv6-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list' - description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: > Update an existing l3-interface-ipv6-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list2' - description: l3-interface-ipv6-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: delete an existing l3-interface-ipv6-address-list operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface} : get: tags: - CloudInfrastructure summary: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan description: returns vlan operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan1' - description: >- Definition of vlan ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan description: > Create or update an existing vlan. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string requestBody: description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan' - description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan description: > Update an existing vlan # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string requestBody: description: vlan object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan2' - description: vlan object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan description: delete an existing vlan operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans : get: tags: - CloudInfrastructure summary: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlans description: returns vlans operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlans parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: query description: '' style: form explode: true schema: type: string - name: vlan-id-inner in: query description: '' style: form explode: true schema: type: integer format: int64 - name: vpn-key in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/vlans1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id} : get: tags: - CloudInfrastructure summary: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf description: returns sriov-vf operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vf1' - description: >- SR-IOV Virtual Function (not to be confused with virtual network function) ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf description: > Create or update an existing sriov-vf. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string requestBody: description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vf' - description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf description: > Update an existing sriov-vf # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string requestBody: description: sriov-vf object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vf2' - description: sriov-vf object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf description: delete an existing sriov-vf operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs : get: tags: - CloudInfrastructure summary: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs description: returns sriov-vfs operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pci-id in: query description: '' style: form explode: true schema: type: string - name: vf-vlan-filter in: query description: '' style: form explode: true schema: type: string - name: vf-mac-filter in: query description: '' style: form explode: true schema: type: string - name: vf-vlan-strip in: query description: '' style: form explode: true schema: type: boolean - name: neutron-network-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vfs1' - description: Collection of SR-IOV Virtual Functions. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - CloudInfrastructure summary: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList description: returns l3-interface-ipv4-address-list operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list1' - description: >- IPv4 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList description: > Create or update an existing l3-interface-ipv4-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list' - description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList description: > Update an existing l3-interface-ipv4-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list2' - description: l3-interface-ipv4-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList description: delete an existing l3-interface-ipv4-address-list operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - CloudInfrastructure summary: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList description: returns l3-interface-ipv6-address-list operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list1' - description: >- IPv6 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList description: > Create or update an existing l3-interface-ipv6-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list' - description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList description: > Update an existing l3-interface-ipv6-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list2' - description: l3-interface-ipv6-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList description: delete an existing l3-interface-ipv6-address-list operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name} : get: tags: - CloudInfrastructure summary: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface description: returns l-interface operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interface1' - description: >- Logical interfaces, e.g., a vnic. ###### Related Nodes - 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 vrf( vrf Uses l-interface, ONE2MANY) - FROM l3-interface-ipv4-address-list (CHILD of l-interface, l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1) - FROM l3-interface-ipv6-address-list (CHILD of l-interface, l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1) - FROM lag-interface( lag-interface Uses l-interface, 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface description: > Create or update an existing l-interface. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string requestBody: description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interface' - description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface description: > Update an existing l-interface # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string requestBody: description: l-interface object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interface2' - description: l-interface object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface description: delete an existing l-interface operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces: get: tags: - CloudInfrastructure summary: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfaces description: returns l-interfaces operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfaces parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: interface-id in: query description: '' style: form explode: true schema: type: string - name: macaddr in: query description: '' style: form explode: true schema: type: string - name: network-name in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interfaces1' - description: Collection of logical interfaces. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}: get: tags: - CloudInfrastructure summary: getCloudInfrastructurePserversPserverPInterfacesPInterface description: returns p-interface operationId: getCloudInfrastructurePserversPserverPInterfacesPInterface parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/p-interface1' - description: >- Physical interface (e.g., nic) ###### Related Nodes - 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 allotted-resource( allotted-resource Uses p-interface, ONE2MANY) AAI-1925 For CCVPN Usecase - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterface description: > Create or update an existing p-interface. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterface parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string requestBody: description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterface.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/p-interface' - description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverPInterfacesPInterface.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructurePserversPserverPInterfacesPInterface description: > Update an existing p-interface # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterface parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string requestBody: description: p-interface object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/p-interface2' - description: p-interface object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverPInterfacesPInterface description: delete an existing p-interface operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterface parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces: get: tags: - CloudInfrastructure summary: getCloudInfrastructurePserversPserverPInterfaces description: returns p-interfaces operationId: getCloudInfrastructurePserversPserverPInterfaces parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: query description: '' style: form explode: true schema: type: string - name: prov-status in: query description: '' style: form explode: true schema: type: string - name: operational-status in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/p-interfaces1' - description: Collection of physical interfaces. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - CloudInfrastructure summary: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: returns l3-interface-ipv4-address-list operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list1' - description: >- IPv4 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: > Create or update an existing l3-interface-ipv4-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list' - description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: > Update an existing l3-interface-ipv4-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list2' - description: l3-interface-ipv4-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: delete an existing l3-interface-ipv4-address-list operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - CloudInfrastructure summary: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: returns l3-interface-ipv6-address-list operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list1' - description: >- IPv6 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: > Create or update an existing l3-interface-ipv6-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list' - description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: > Update an existing l3-interface-ipv6-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list2' - description: l3-interface-ipv6-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: delete an existing l3-interface-ipv6-address-list operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface} : get: tags: - CloudInfrastructure summary: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan description: returns vlan operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan1' - description: >- Definition of vlan ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan description: > Create or update an existing vlan. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string requestBody: description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan' - description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan description: > Update an existing vlan # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string requestBody: description: vlan object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan2' - description: vlan object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan description: delete an existing vlan operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans : get: tags: - CloudInfrastructure summary: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlans description: returns vlans operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlans parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: query description: '' style: form explode: true schema: type: string - name: vlan-id-inner in: query description: '' style: form explode: true schema: type: integer format: int64 - name: vpn-key in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/vlans1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id} : get: tags: - CloudInfrastructure summary: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf description: returns sriov-vf operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vf1' - description: >- SR-IOV Virtual Function (not to be confused with virtual network function) ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf description: > Create or update an existing sriov-vf. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string requestBody: description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vf' - description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf description: > Update an existing sriov-vf # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string requestBody: description: sriov-vf object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vf2' - description: sriov-vf object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf description: delete an existing sriov-vf operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs : get: tags: - CloudInfrastructure summary: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs description: returns sriov-vfs operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: pci-id in: query description: '' style: form explode: true schema: type: string - name: vf-vlan-filter in: query description: '' style: form explode: true schema: type: string - name: vf-mac-filter in: query description: '' style: form explode: true schema: type: string - name: vf-vlan-strip in: query description: '' style: form explode: true schema: type: boolean - name: neutron-network-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vfs1' - description: Collection of SR-IOV Virtual Functions. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - CloudInfrastructure summary: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList description: returns l3-interface-ipv4-address-list operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list1' - description: >- IPv4 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList description: > Create or update an existing l3-interface-ipv4-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list' - description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList description: > Update an existing l3-interface-ipv4-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list2' - description: l3-interface-ipv4-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList description: delete an existing l3-interface-ipv4-address-list operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - CloudInfrastructure summary: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList description: returns l3-interface-ipv6-address-list operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list1' - description: >- IPv6 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList description: > Create or update an existing l3-interface-ipv6-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list' - description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList description: > Update an existing l3-interface-ipv6-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list2' - description: l3-interface-ipv6-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList description: delete an existing l3-interface-ipv6-address-list operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name} : get: tags: - CloudInfrastructure summary: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface description: returns l-interface operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interface1' - description: >- Logical interfaces, e.g., a vnic. ###### Related Nodes - 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 vrf( vrf Uses l-interface, ONE2MANY) - FROM l3-interface-ipv4-address-list (CHILD of l-interface, l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1) - FROM l3-interface-ipv6-address-list (CHILD of l-interface, l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1) - FROM lag-interface( lag-interface Uses l-interface, 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface description: > Create or update an existing l-interface. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string requestBody: description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interface' - description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface description: > Update an existing l-interface # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string requestBody: description: l-interface object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interface2' - description: l-interface object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface description: delete an existing l-interface operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces: get: tags: - CloudInfrastructure summary: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfaces description: returns l-interfaces operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfaces parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: interface-id in: query description: '' style: form explode: true schema: type: string - name: macaddr in: query description: '' style: form explode: true schema: type: string - name: network-name in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interfaces1' - description: Collection of logical interfaces. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}: get: tags: - CloudInfrastructure summary: getCloudInfrastructurePserversPserverLagInterfacesLagInterface description: returns lag-interface operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterface parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/lag-interface1' - description: >- Link aggregate interface ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface description: > Create or update an existing lag-interface. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string requestBody: description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/lag-interface' - description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface description: > Update an existing lag-interface # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string requestBody: description: lag-interface object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/lag-interface2' - description: lag-interface object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterface description: delete an existing lag-interface operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterface parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces: get: tags: - CloudInfrastructure summary: getCloudInfrastructurePserversPserverLagInterfaces description: returns lag-interfaces operationId: getCloudInfrastructurePserversPserverLagInterfaces parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: interface-name in: query description: '' style: form explode: true schema: type: string - name: interface-id in: query description: '' style: form explode: true schema: type: string - name: interface-role in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/lag-interfaces1' - description: Collection of link aggregate interfaces. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/pservers/pserver/{hostname}/hpa-capacity/{hpa-capacity-key}/relationship-list/relationship: put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverHpaCapacityRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructurePserversPserverHpaCapacityRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: hpa-capacity-key in: path description: Composite key formed with hpaFeature and append list of hpaFeatureAttributes needed for capacity check required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverHpaCapacity.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverHpaCapacity.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverHpaCapacityRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructurePserversPserverHpaCapacityRelationshipListRelationship parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: hpa-capacity-key in: path description: Composite key formed with hpaFeature and append list of hpaFeatureAttributes needed for capacity check required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/pservers/pserver/{hostname}/hpa-capacity/{hpa-capacity-key}: get: tags: - CloudInfrastructure summary: getCloudInfrastructurePserversPserverHpaCapacity description: returns hpa-capacity operationId: getCloudInfrastructurePserversPserverHpaCapacity parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: hpa-capacity-key in: path description: Composite key formed with hpaFeature and append list of hpaFeatureAttributes needed for capacity check required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/hpa-capacity1' - description: >- HPA Capacity information for compute node ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserverHpaCapacity description: > Create or update an existing hpa-capacity. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructurePserversPserverHpaCapacity parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: hpa-capacity-key in: path description: Composite key formed with hpaFeature and append list of hpaFeatureAttributes needed for capacity check required: true style: simple schema: type: string requestBody: description: hpa-capacity object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverHpaCapacity.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/hpa-capacity' - description: hpa-capacity object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserverHpaCapacity.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructurePserversPserverHpaCapacity description: > Update an existing hpa-capacity # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructurePserversPserverHpaCapacity parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: hpa-capacity-key in: path description: Composite key formed with hpaFeature and append list of hpaFeatureAttributes needed for capacity check required: true style: simple schema: type: string requestBody: description: hpa-capacity object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/hpa-capacity2' - description: hpa-capacity object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserverHpaCapacity description: delete an existing hpa-capacity operationId: deleteCloudInfrastructurePserversPserverHpaCapacity parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: hpa-capacity-key in: path description: Composite key formed with hpaFeature and append list of hpaFeatureAttributes needed for capacity check required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/pservers/pserver/{hostname}: get: tags: - CloudInfrastructure summary: getCloudInfrastructurePserversPserver description: returns pserver operationId: getCloudInfrastructurePserversPserver parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/pserver1' - description: >- Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver. ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructurePserversPserver description: > Create or update an existing pserver. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructurePserversPserver parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string requestBody: description: pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserver.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/pserver' - description: pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructurePserversPserver.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructurePserversPserver description: > Update an existing pserver # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructurePserversPserver parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string requestBody: description: pserver object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/pserver2' - description: pserver object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructurePserversPserver description: delete an existing pserver operationId: deleteCloudInfrastructurePserversPserver parameters: - name: hostname in: path description: Value from executing hostname on the compute node. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/pservers: get: tags: - CloudInfrastructure summary: getCloudInfrastructurePservers description: returns pservers operationId: getCloudInfrastructurePservers parameters: - name: hostname in: query description: '' style: form explode: true schema: type: string - name: inv-status in: query description: '' style: form explode: true schema: type: string - name: pserver-id in: query description: '' style: form explode: true schema: type: string - name: in-maint in: query description: '' style: form explode: true schema: type: boolean - name: pserver-name2 in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/pservers1' - description: Collection of compute hosts. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship: put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship parameters: - name: vdc-id in: path description: Unique ID of the vdc required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship parameters: - name: vdc-id in: path description: Unique ID of the vdc required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}: get: tags: - CloudInfrastructure summary: getCloudInfrastructureVirtualDataCentersVirtualDataCenter description: returns virtual-data-center operationId: getCloudInfrastructureVirtualDataCentersVirtualDataCenter parameters: - name: vdc-id in: path description: Unique ID of the vdc required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/virtual-data-center1' - description: >- Virtual organization of cloud infrastructure elements in a data center context ###### Related Nodes - 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) default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter description: > Create or update an existing virtual-data-center. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter parameters: - name: vdc-id in: path description: Unique ID of the vdc required: true style: simple schema: type: string requestBody: description: virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/virtual-data-center' - description: virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter description: > Update an existing virtual-data-center # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter parameters: - name: vdc-id in: path description: Unique ID of the vdc required: true style: simple schema: type: string requestBody: description: virtual-data-center object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/virtual-data-center2' - description: virtual-data-center object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenter description: delete an existing virtual-data-center operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenter parameters: - name: vdc-id in: path description: Unique ID of the vdc required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/virtual-data-centers: get: tags: - CloudInfrastructure summary: getCloudInfrastructureVirtualDataCenters description: returns virtual-data-centers operationId: getCloudInfrastructureVirtualDataCenters parameters: - name: vdc-id in: query description: '' style: form explode: true schema: type: string - name: vdc-name in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/virtual-data-centers1' - description: Virtual organization of cloud infrastructure elements in a data center context default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}/relationship-list/relationship : put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironmentRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironmentRelationshipListRelationship parameters: - name: operational-environment-id in: path description: UUID of an operational environment required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureOperationalEnvironmentsOperationalEnvironment.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureOperationalEnvironmentsOperationalEnvironment.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureOperationalEnvironmentsOperationalEnvironmentRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructureOperationalEnvironmentsOperationalEnvironmentRelationshipListRelationship parameters: - name: operational-environment-id in: path description: UUID of an operational environment required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}: get: tags: - CloudInfrastructure summary: getCloudInfrastructureOperationalEnvironmentsOperationalEnvironment description: returns operational-environment operationId: getCloudInfrastructureOperationalEnvironmentsOperationalEnvironment parameters: - name: operational-environment-id in: path description: UUID of an operational environment required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/operational-environment1' - description: >- It is a logical partition of the cloud which allows to have multiple environments in the production AIC. ###### Related Nodes - TO operational-environment( operational-environment Uses operational-environment, MANY2MANY) - FROM operational-environment( operational-environment Uses operational-environment, MANY2MANY) default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironment description: > Create or update an existing operational-environment. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironment parameters: - name: operational-environment-id in: path description: UUID of an operational environment required: true style: simple schema: type: string requestBody: description: operational-environment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureOperationalEnvironmentsOperationalEnvironment.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/operational-environment' - description: operational-environment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureOperationalEnvironmentsOperationalEnvironment.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironment description: > Update an existing operational-environment # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironment parameters: - name: operational-environment-id in: path description: UUID of an operational environment required: true style: simple schema: type: string requestBody: description: operational-environment object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/operational-environment2' - description: operational-environment object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureOperationalEnvironmentsOperationalEnvironment description: delete an existing operational-environment operationId: deleteCloudInfrastructureOperationalEnvironmentsOperationalEnvironment parameters: - name: operational-environment-id in: path description: UUID of an operational environment required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/operational-environments: get: tags: - CloudInfrastructure summary: getCloudInfrastructureOperationalEnvironments description: returns operational-environments operationId: getCloudInfrastructureOperationalEnvironments parameters: - name: operational-environment-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/operational-environments1' - description: a logical partition of the cloud which allows to have multiple environments in the production AIC. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/network-technologies/network-technology/{network-technology-id}/relationship-list/relationship: put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureNetworkTechnologiesNetworkTechnologyRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCloudInfrastructureNetworkTechnologiesNetworkTechnologyRelationshipListRelationship parameters: - name: network-technology-id in: path description: Unique identifier of the network-technology object (UUID) required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureNetworkTechnologiesNetworkTechnology.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureNetworkTechnologiesNetworkTechnology.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureNetworkTechnologiesNetworkTechnologyRelationshipListRelationship description: delete an existing relationship operationId: deleteCloudInfrastructureNetworkTechnologiesNetworkTechnologyRelationshipListRelationship parameters: - name: network-technology-id in: path description: Unique identifier of the network-technology object (UUID) required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/network-technologies/network-technology/{network-technology-id}: get: tags: - CloudInfrastructure summary: getCloudInfrastructureNetworkTechnologiesNetworkTechnology description: returns network-technology operationId: getCloudInfrastructureNetworkTechnologiesNetworkTechnology parameters: - name: network-technology-id in: path description: Unique identifier of the network-technology object (UUID) required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/network-technology1' - description: >- The network-technology object is used to capture the supported network technologies of a cloud-region. ###### Related Nodes - FROM cloud-region( cloud-region Uses network-technology, MANY2MANY) default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - CloudInfrastructure summary: createOrUpdateCloudInfrastructureNetworkTechnologiesNetworkTechnology description: > Create or update an existing network-technology. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCloudInfrastructureNetworkTechnologiesNetworkTechnology parameters: - name: network-technology-id in: path description: Unique identifier of the network-technology object (UUID) required: true style: simple schema: type: string requestBody: description: network-technology object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureNetworkTechnologiesNetworkTechnology.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/network-technology' - description: network-technology object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CloudInfrastructureNetworkTechnologiesNetworkTechnology.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - CloudInfrastructure summary: UpdateCloudInfrastructureNetworkTechnologiesNetworkTechnology description: > Update an existing network-technology # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCloudInfrastructureNetworkTechnologiesNetworkTechnology parameters: - name: network-technology-id in: path description: Unique identifier of the network-technology object (UUID) required: true style: simple schema: type: string requestBody: description: network-technology object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/network-technology2' - description: network-technology object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - CloudInfrastructure summary: deleteCloudInfrastructureNetworkTechnologiesNetworkTechnology description: delete an existing network-technology operationId: deleteCloudInfrastructureNetworkTechnologiesNetworkTechnology parameters: - name: network-technology-id in: path description: Unique identifier of the network-technology object (UUID) required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /cloud-infrastructure/network-technologies: get: tags: - CloudInfrastructure summary: getCloudInfrastructureNetworkTechnologies description: returns network-technologies operationId: getCloudInfrastructureNetworkTechnologies parameters: [] responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/network-technologies1' - description: The network-technology object is used to capture the supported network technologies of a cloud-region. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship : put: tags: - ExternalSystem summary: createOrUpdateExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfoRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfoRelationshipListRelationship parameters: - name: ems-id in: path description: Unique ID of EMS. required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfo.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfo.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ExternalSystem summary: deleteExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfoRelationshipListRelationship description: delete an existing relationship operationId: deleteExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfoRelationshipListRelationship parameters: - name: ems-id in: path description: Unique ID of EMS. required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}: get: tags: - ExternalSystem summary: getExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfo description: returns esr-system-info operationId: getExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfo parameters: - name: ems-id in: path description: Unique ID of EMS. required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/esr-system-info1' - description: >- Persist common address information of external systems. ###### Related Nodes - TO cloud-region (PARENT of esr-system-info, esr-system-info BelongsTo cloud-region, MANY2ONE)(4) - TO esr-ems (PARENT of esr-system-info, esr-system-info BelongsTo esr-ems, MANY2ONE)(4) - TO esr-nfvo (PARENT of esr-system-info, esr-system-info BelongsTo esr-nfvo, ONE2ONE)(4) - TO esr-thirdparty-sdnc (PARENT of esr-system-info, esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4) - TO esr-vnfm (PARENT of esr-system-info, esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4) - FROM ext-aai-network (PARENT of esr-system-info, ext-aai-network Uses esr-system-info, ONE2MANY) For CCVPN Usecase(3) -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also -ESR-SYSTEM-INFO cannot be deleted if related to EXT-AAI-NETWORK default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - ExternalSystem summary: createOrUpdateExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfo description: > Create or update an existing esr-system-info. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfo parameters: - name: ems-id in: path description: Unique ID of EMS. required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string requestBody: description: esr-system-info object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfo.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/esr-system-info' - description: esr-system-info object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfo.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - ExternalSystem summary: UpdateExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfo description: > Update an existing esr-system-info # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfo parameters: - name: ems-id in: path description: Unique ID of EMS. required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string requestBody: description: esr-system-info object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/esr-system-info2' - description: esr-system-info object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ExternalSystem summary: deleteExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfo description: delete an existing esr-system-info operationId: deleteExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfo parameters: - name: ems-id in: path description: Unique ID of EMS. required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list: get: tags: - ExternalSystem summary: getExternalSystemEsrEmsListEsrEmsEsrSystemInfoList description: returns esr-system-info-list operationId: getExternalSystemEsrEmsListEsrEmsEsrSystemInfoList parameters: - name: ems-id in: path description: Unique ID of EMS. required: true style: simple schema: type: string - name: esr-system-info-id in: query description: '' style: form explode: true schema: type: string - name: system-name in: query description: '' style: form explode: true schema: type: string - name: system-type in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/esr-system-info-list1' - description: Collection of persistent block-level external system auth info. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /external-system/esr-ems-list/esr-ems/{ems-id}/relationship-list/relationship: put: tags: - ExternalSystem summary: createOrUpdateExternalSystemEsrEmsListEsrEmsRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateExternalSystemEsrEmsListEsrEmsRelationshipListRelationship parameters: - name: ems-id in: path description: Unique ID of EMS. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrEmsListEsrEms.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrEmsListEsrEms.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ExternalSystem summary: deleteExternalSystemEsrEmsListEsrEmsRelationshipListRelationship description: delete an existing relationship operationId: deleteExternalSystemEsrEmsListEsrEmsRelationshipListRelationship parameters: - name: ems-id in: path description: Unique ID of EMS. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /external-system/esr-ems-list/esr-ems/{ems-id}: get: tags: - ExternalSystem summary: getExternalSystemEsrEmsListEsrEms description: returns esr-ems operationId: getExternalSystemEsrEmsListEsrEms parameters: - name: ems-id in: path description: Unique ID of EMS. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/esr-ems1' - description: >- Persist EMS address information used by EMS driver. ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - ExternalSystem summary: createOrUpdateExternalSystemEsrEmsListEsrEms description: > Create or update an existing esr-ems. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateExternalSystemEsrEmsListEsrEms parameters: - name: ems-id in: path description: Unique ID of EMS. required: true style: simple schema: type: string requestBody: description: esr-ems object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrEmsListEsrEms.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/esr-ems' - description: esr-ems object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrEmsListEsrEms.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - ExternalSystem summary: UpdateExternalSystemEsrEmsListEsrEms description: > Update an existing esr-ems # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateExternalSystemEsrEmsListEsrEms parameters: - name: ems-id in: path description: Unique ID of EMS. required: true style: simple schema: type: string requestBody: description: esr-ems object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/esr-ems2' - description: esr-ems object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ExternalSystem summary: deleteExternalSystemEsrEmsListEsrEms description: delete an existing esr-ems operationId: deleteExternalSystemEsrEmsListEsrEms parameters: - name: ems-id in: path description: Unique ID of EMS. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /external-system/esr-ems-list: get: tags: - ExternalSystem summary: getExternalSystemEsrEmsList description: returns esr-ems-list operationId: getExternalSystemEsrEmsList parameters: - name: ems-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/esr-ems-list1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship : put: tags: - ExternalSystem summary: createOrUpdateExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfoRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfoRelationshipListRelationship parameters: - name: vnfm-id in: path description: Unique ID of VNFM. required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfo.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfo.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ExternalSystem summary: deleteExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfoRelationshipListRelationship description: delete an existing relationship operationId: deleteExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfoRelationshipListRelationship parameters: - name: vnfm-id in: path description: Unique ID of VNFM. required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}: get: tags: - ExternalSystem summary: getExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfo description: returns esr-system-info operationId: getExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfo parameters: - name: vnfm-id in: path description: Unique ID of VNFM. required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/esr-system-info1' - description: >- Persist common address information of external systems. ###### Related Nodes - TO cloud-region (PARENT of esr-system-info, esr-system-info BelongsTo cloud-region, MANY2ONE)(4) - TO esr-ems (PARENT of esr-system-info, esr-system-info BelongsTo esr-ems, MANY2ONE)(4) - TO esr-nfvo (PARENT of esr-system-info, esr-system-info BelongsTo esr-nfvo, ONE2ONE)(4) - TO esr-thirdparty-sdnc (PARENT of esr-system-info, esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4) - TO esr-vnfm (PARENT of esr-system-info, esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4) - FROM ext-aai-network (PARENT of esr-system-info, ext-aai-network Uses esr-system-info, ONE2MANY) For CCVPN Usecase(3) -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also -ESR-SYSTEM-INFO cannot be deleted if related to EXT-AAI-NETWORK default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - ExternalSystem summary: createOrUpdateExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfo description: > Create or update an existing esr-system-info. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfo parameters: - name: vnfm-id in: path description: Unique ID of VNFM. required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string requestBody: description: esr-system-info object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfo.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/esr-system-info' - description: esr-system-info object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfo.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - ExternalSystem summary: UpdateExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfo description: > Update an existing esr-system-info # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfo parameters: - name: vnfm-id in: path description: Unique ID of VNFM. required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string requestBody: description: esr-system-info object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/esr-system-info2' - description: esr-system-info object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ExternalSystem summary: deleteExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfo description: delete an existing esr-system-info operationId: deleteExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfo parameters: - name: vnfm-id in: path description: Unique ID of VNFM. required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list: get: tags: - ExternalSystem summary: getExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoList description: returns esr-system-info-list operationId: getExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoList parameters: - name: vnfm-id in: path description: Unique ID of VNFM. required: true style: simple schema: type: string - name: esr-system-info-id in: query description: '' style: form explode: true schema: type: string - name: system-name in: query description: '' style: form explode: true schema: type: string - name: system-type in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/esr-system-info-list1' - description: Collection of persistent block-level external system auth info. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/relationship-list/relationship: put: tags: - ExternalSystem summary: createOrUpdateExternalSystemEsrVnfmListEsrVnfmRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateExternalSystemEsrVnfmListEsrVnfmRelationshipListRelationship parameters: - name: vnfm-id in: path description: Unique ID of VNFM. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrVnfmListEsrVnfm.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrVnfmListEsrVnfm.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ExternalSystem summary: deleteExternalSystemEsrVnfmListEsrVnfmRelationshipListRelationship description: delete an existing relationship operationId: deleteExternalSystemEsrVnfmListEsrVnfmRelationshipListRelationship parameters: - name: vnfm-id in: path description: Unique ID of VNFM. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}: get: tags: - ExternalSystem summary: getExternalSystemEsrVnfmListEsrVnfm description: returns esr-vnfm operationId: getExternalSystemEsrVnfmListEsrVnfm parameters: - name: vnfm-id in: path description: Unique ID of VNFM. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/esr-vnfm1' - description: >- Persist VNFM address information used by VF-C. ###### Related Nodes - FROM esr-system-info (CHILD of esr-vnfm, esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1) - FROM generic-vnf( generic-vnf DependsOn esr-vnfm, MANY2ONE) -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - ExternalSystem summary: createOrUpdateExternalSystemEsrVnfmListEsrVnfm description: > Create or update an existing esr-vnfm. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateExternalSystemEsrVnfmListEsrVnfm parameters: - name: vnfm-id in: path description: Unique ID of VNFM. required: true style: simple schema: type: string requestBody: description: esr-vnfm object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrVnfmListEsrVnfm.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/esr-vnfm' - description: esr-vnfm object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrVnfmListEsrVnfm.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - ExternalSystem summary: UpdateExternalSystemEsrVnfmListEsrVnfm description: > Update an existing esr-vnfm # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateExternalSystemEsrVnfmListEsrVnfm parameters: - name: vnfm-id in: path description: Unique ID of VNFM. required: true style: simple schema: type: string requestBody: description: esr-vnfm object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/esr-vnfm2' - description: esr-vnfm object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ExternalSystem summary: deleteExternalSystemEsrVnfmListEsrVnfm description: delete an existing esr-vnfm operationId: deleteExternalSystemEsrVnfmListEsrVnfm parameters: - name: vnfm-id in: path description: Unique ID of VNFM. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /external-system/esr-vnfm-list: get: tags: - ExternalSystem summary: getExternalSystemEsrVnfmList description: returns esr-vnfm-list operationId: getExternalSystemEsrVnfmList parameters: - name: vnfm-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/esr-vnfm-list1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /external-system/esr-nfvo-list/esr-nfvo/{nfvo-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship : put: tags: - ExternalSystem summary: createOrUpdateExternalSystemEsrNfvoListEsrNfvoEsrSystemInfoListEsrSystemInfoRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateExternalSystemEsrNfvoListEsrNfvoEsrSystemInfoListEsrSystemInfoRelationshipListRelationship parameters: - name: nfvo-id in: path description: Unique ID of nfvo. required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrNfvoListEsrNfvoEsrSystemInfoListEsrSystemInfo.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrNfvoListEsrNfvoEsrSystemInfoListEsrSystemInfo.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ExternalSystem summary: deleteExternalSystemEsrNfvoListEsrNfvoEsrSystemInfoListEsrSystemInfoRelationshipListRelationship description: delete an existing relationship operationId: deleteExternalSystemEsrNfvoListEsrNfvoEsrSystemInfoListEsrSystemInfoRelationshipListRelationship parameters: - name: nfvo-id in: path description: Unique ID of nfvo. required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /external-system/esr-nfvo-list/esr-nfvo/{nfvo-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}: get: tags: - ExternalSystem summary: getExternalSystemEsrNfvoListEsrNfvoEsrSystemInfoListEsrSystemInfo description: returns esr-system-info operationId: getExternalSystemEsrNfvoListEsrNfvoEsrSystemInfoListEsrSystemInfo parameters: - name: nfvo-id in: path description: Unique ID of nfvo. required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/esr-system-info1' - description: >- Persist common address information of external systems. ###### Related Nodes - TO cloud-region (PARENT of esr-system-info, esr-system-info BelongsTo cloud-region, MANY2ONE)(4) - TO esr-ems (PARENT of esr-system-info, esr-system-info BelongsTo esr-ems, MANY2ONE)(4) - TO esr-nfvo (PARENT of esr-system-info, esr-system-info BelongsTo esr-nfvo, ONE2ONE)(4) - TO esr-thirdparty-sdnc (PARENT of esr-system-info, esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4) - TO esr-vnfm (PARENT of esr-system-info, esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4) - FROM ext-aai-network (PARENT of esr-system-info, ext-aai-network Uses esr-system-info, ONE2MANY) For CCVPN Usecase(3) -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also -ESR-SYSTEM-INFO cannot be deleted if related to EXT-AAI-NETWORK default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - ExternalSystem summary: createOrUpdateExternalSystemEsrNfvoListEsrNfvoEsrSystemInfoListEsrSystemInfo description: > Create or update an existing esr-system-info. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateExternalSystemEsrNfvoListEsrNfvoEsrSystemInfoListEsrSystemInfo parameters: - name: nfvo-id in: path description: Unique ID of nfvo. required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string requestBody: description: esr-system-info object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrNfvoListEsrNfvoEsrSystemInfoListEsrSystemInfo.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/esr-system-info' - description: esr-system-info object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrNfvoListEsrNfvoEsrSystemInfoListEsrSystemInfo.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - ExternalSystem summary: UpdateExternalSystemEsrNfvoListEsrNfvoEsrSystemInfoListEsrSystemInfo description: > Update an existing esr-system-info # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateExternalSystemEsrNfvoListEsrNfvoEsrSystemInfoListEsrSystemInfo parameters: - name: nfvo-id in: path description: Unique ID of nfvo. required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string requestBody: description: esr-system-info object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/esr-system-info2' - description: esr-system-info object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ExternalSystem summary: deleteExternalSystemEsrNfvoListEsrNfvoEsrSystemInfoListEsrSystemInfo description: delete an existing esr-system-info operationId: deleteExternalSystemEsrNfvoListEsrNfvoEsrSystemInfoListEsrSystemInfo parameters: - name: nfvo-id in: path description: Unique ID of nfvo. required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /external-system/esr-nfvo-list/esr-nfvo/{nfvo-id}/esr-system-info-list: get: tags: - ExternalSystem summary: getExternalSystemEsrNfvoListEsrNfvoEsrSystemInfoList description: returns esr-system-info-list operationId: getExternalSystemEsrNfvoListEsrNfvoEsrSystemInfoList parameters: - name: nfvo-id in: path description: Unique ID of nfvo. required: true style: simple schema: type: string - name: esr-system-info-id in: query description: '' style: form explode: true schema: type: string - name: system-name in: query description: '' style: form explode: true schema: type: string - name: system-type in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/esr-system-info-list1' - description: Collection of persistent block-level external system auth info. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /external-system/esr-nfvo-list/esr-nfvo/{nfvo-id}/relationship-list/relationship: put: tags: - ExternalSystem summary: createOrUpdateExternalSystemEsrNfvoListEsrNfvoRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateExternalSystemEsrNfvoListEsrNfvoRelationshipListRelationship parameters: - name: nfvo-id in: path description: Unique ID of nfvo. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrNfvoListEsrNfvo.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrNfvoListEsrNfvo.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ExternalSystem summary: deleteExternalSystemEsrNfvoListEsrNfvoRelationshipListRelationship description: delete an existing relationship operationId: deleteExternalSystemEsrNfvoListEsrNfvoRelationshipListRelationship parameters: - name: nfvo-id in: path description: Unique ID of nfvo. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /external-system/esr-nfvo-list/esr-nfvo/{nfvo-id}: get: tags: - ExternalSystem summary: getExternalSystemEsrNfvoListEsrNfvo description: returns esr-nfvo operationId: getExternalSystemEsrNfvoListEsrNfvo parameters: - name: nfvo-id in: path description: Unique ID of nfvo. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/esr-nfvo1' - description: >- Persist NFVO address information used by VF-C. ###### Related Nodes - FROM esr-system-info (CHILD of esr-nfvo, esr-system-info BelongsTo esr-nfvo, ONE2ONE)(1) -(1) IF this ESR-NFVO node is deleted, this FROM node is DELETED also default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - ExternalSystem summary: createOrUpdateExternalSystemEsrNfvoListEsrNfvo description: > Create or update an existing esr-nfvo. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateExternalSystemEsrNfvoListEsrNfvo parameters: - name: nfvo-id in: path description: Unique ID of nfvo. required: true style: simple schema: type: string requestBody: description: esr-nfvo object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrNfvoListEsrNfvo.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/esr-nfvo' - description: esr-nfvo object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrNfvoListEsrNfvo.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - ExternalSystem summary: UpdateExternalSystemEsrNfvoListEsrNfvo description: > Update an existing esr-nfvo # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateExternalSystemEsrNfvoListEsrNfvo parameters: - name: nfvo-id in: path description: Unique ID of nfvo. required: true style: simple schema: type: string requestBody: description: esr-nfvo object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/esr-nfvo2' - description: esr-nfvo object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ExternalSystem summary: deleteExternalSystemEsrNfvoListEsrNfvo description: delete an existing esr-nfvo operationId: deleteExternalSystemEsrNfvoListEsrNfvo parameters: - name: nfvo-id in: path description: Unique ID of nfvo. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /external-system/esr-nfvo-list: get: tags: - ExternalSystem summary: getExternalSystemEsrNfvoList description: returns esr-nfvo-list operationId: getExternalSystemEsrNfvoList parameters: - name: nfvo-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/esr-nfvo-list1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship : put: tags: - ExternalSystem summary: createOrUpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfoRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfoRelationshipListRelationship parameters: - name: thirdparty-sdnc-id in: path description: Unique ID of SDNC. required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfo.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfo.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ExternalSystem summary: deleteExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfoRelationshipListRelationship description: delete an existing relationship operationId: deleteExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfoRelationshipListRelationship parameters: - name: thirdparty-sdnc-id in: path description: Unique ID of SDNC. required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id} : get: tags: - ExternalSystem summary: getExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfo description: returns esr-system-info operationId: getExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfo parameters: - name: thirdparty-sdnc-id in: path description: Unique ID of SDNC. required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/esr-system-info1' - description: >- Persist common address information of external systems. ###### Related Nodes - TO cloud-region (PARENT of esr-system-info, esr-system-info BelongsTo cloud-region, MANY2ONE)(4) - TO esr-ems (PARENT of esr-system-info, esr-system-info BelongsTo esr-ems, MANY2ONE)(4) - TO esr-nfvo (PARENT of esr-system-info, esr-system-info BelongsTo esr-nfvo, ONE2ONE)(4) - TO esr-thirdparty-sdnc (PARENT of esr-system-info, esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4) - TO esr-vnfm (PARENT of esr-system-info, esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4) - FROM ext-aai-network (PARENT of esr-system-info, ext-aai-network Uses esr-system-info, ONE2MANY) For CCVPN Usecase(3) -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also -ESR-SYSTEM-INFO cannot be deleted if related to EXT-AAI-NETWORK default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - ExternalSystem summary: createOrUpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfo description: > Create or update an existing esr-system-info. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfo parameters: - name: thirdparty-sdnc-id in: path description: Unique ID of SDNC. required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string requestBody: description: esr-system-info object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfo.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/esr-system-info' - description: esr-system-info object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfo.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - ExternalSystem summary: UpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfo description: > Update an existing esr-system-info # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfo parameters: - name: thirdparty-sdnc-id in: path description: Unique ID of SDNC. required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string requestBody: description: esr-system-info object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/esr-system-info2' - description: esr-system-info object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ExternalSystem summary: deleteExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfo description: delete an existing esr-system-info operationId: deleteExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfo parameters: - name: thirdparty-sdnc-id in: path description: Unique ID of SDNC. required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list: get: tags: - ExternalSystem summary: getExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoList description: returns esr-system-info-list operationId: getExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoList parameters: - name: thirdparty-sdnc-id in: path description: Unique ID of SDNC. required: true style: simple schema: type: string - name: esr-system-info-id in: query description: '' style: form explode: true schema: type: string - name: system-name in: query description: '' style: form explode: true schema: type: string - name: system-type in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/esr-system-info-list1' - description: Collection of persistent block-level external system auth info. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/relationship-list/relationship: put: tags: - ExternalSystem summary: createOrUpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdncRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdncRelationshipListRelationship parameters: - name: thirdparty-sdnc-id in: path description: Unique ID of SDNC. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrThirdpartySdncListEsrThirdpartySdnc.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrThirdpartySdncListEsrThirdpartySdnc.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ExternalSystem summary: deleteExternalSystemEsrThirdpartySdncListEsrThirdpartySdncRelationshipListRelationship description: delete an existing relationship operationId: deleteExternalSystemEsrThirdpartySdncListEsrThirdpartySdncRelationshipListRelationship parameters: - name: thirdparty-sdnc-id in: path description: Unique ID of SDNC. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}: get: tags: - ExternalSystem summary: getExternalSystemEsrThirdpartySdncListEsrThirdpartySdnc description: returns esr-thirdparty-sdnc operationId: getExternalSystemEsrThirdpartySdncListEsrThirdpartySdnc parameters: - name: thirdparty-sdnc-id in: path description: Unique ID of SDNC. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/esr-thirdparty-sdnc1' - description: >- Persist SDNC address information used by ONAP SDNC. ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - ExternalSystem summary: createOrUpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdnc description: > Create or update an existing esr-thirdparty-sdnc. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdnc parameters: - name: thirdparty-sdnc-id in: path description: Unique ID of SDNC. required: true style: simple schema: type: string requestBody: description: esr-thirdparty-sdnc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrThirdpartySdncListEsrThirdpartySdnc.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/esr-thirdparty-sdnc' - description: esr-thirdparty-sdnc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ExternalSystemEsrThirdpartySdncListEsrThirdpartySdnc.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - ExternalSystem summary: UpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdnc description: > Update an existing esr-thirdparty-sdnc # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdnc parameters: - name: thirdparty-sdnc-id in: path description: Unique ID of SDNC. required: true style: simple schema: type: string requestBody: description: esr-thirdparty-sdnc object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/esr-thirdparty-sdnc2' - description: esr-thirdparty-sdnc object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ExternalSystem summary: deleteExternalSystemEsrThirdpartySdncListEsrThirdpartySdnc description: delete an existing esr-thirdparty-sdnc operationId: deleteExternalSystemEsrThirdpartySdncListEsrThirdpartySdnc parameters: - name: thirdparty-sdnc-id in: path description: Unique ID of SDNC. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /external-system/esr-thirdparty-sdnc-list: get: tags: - ExternalSystem summary: getExternalSystemEsrThirdpartySdncList description: returns esr-thirdparty-sdnc-list operationId: getExternalSystemEsrThirdpartySdncList parameters: [] responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/esr-thirdparty-sdnc-list1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /business/connectors/connector/{resource-instance-id}/relationship-list/relationship: put: tags: - Business summary: createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship parameters: - name: resource-instance-id in: path description: Unique id of resource instance. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessConnectorsConnector.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessConnectorsConnector.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Business summary: deleteBusinessConnectorsConnectorRelationshipListRelationship description: delete an existing relationship operationId: deleteBusinessConnectorsConnectorRelationshipListRelationship parameters: - name: resource-instance-id in: path description: Unique id of resource instance. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}: get: tags: - Business summary: getBusinessConnectorsConnectorMetadataMetadatum description: returns metadatum operationId: getBusinessConnectorsConnectorMetadataMetadatum parameters: - name: resource-instance-id in: path description: Unique id of resource instance. required: true style: simple schema: type: string - name: metaname in: path description: '' required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/metadatum' - description: >- Key/value pairs ###### Related Nodes - TO configuration (PARENT of metadatum, metadatum BelongsTo configuration, MANY2ONE)(4) - TO connector (PARENT of metadatum, metadatum BelongsTo connector, MANY2ONE)(4) - TO cp( metadatum AppliesTo cp, MANY2MANY) AAI-2154 For BBS Usecase - TO generic-vnf( metadatum AppliesTo generic-vnf, MANY2MANY) AAI-2154 For BBS Usecase - TO image (PARENT of metadatum, metadatum BelongsTo image, MANY2ONE)(4) - TO model-ver (PARENT of metadatum, metadatum BelongsTo model-ver, MANY2ONE)(4) - TO pnf( metadatum AppliesTo pnf, MANY2MANY) AAI-2154 For BBS Usecase - TO service-instance (PARENT of metadatum, metadatum BelongsTo service-instance, MANY2ONE)(4) -(4) IF this TO node is deleted, this METADATUM is DELETED also default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Business summary: createOrUpdateBusinessConnectorsConnectorMetadataMetadatum description: > Create or update an existing metadatum. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateBusinessConnectorsConnectorMetadataMetadatum parameters: - name: resource-instance-id in: path description: Unique id of resource instance. required: true style: simple schema: type: string - name: metaname in: path description: '' required: true style: simple schema: type: string requestBody: description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessConnectorsConnectorMetadataMetadatum.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/metadatum' - description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessConnectorsConnectorMetadataMetadatum.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Business summary: UpdateBusinessConnectorsConnectorMetadataMetadatum description: > Update an existing metadatum # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateBusinessConnectorsConnectorMetadataMetadatum parameters: - name: resource-instance-id in: path description: Unique id of resource instance. required: true style: simple schema: type: string - name: metaname in: path description: '' required: true style: simple schema: type: string requestBody: description: metadatum object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/metadatum2' - description: metadatum object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Business summary: deleteBusinessConnectorsConnectorMetadataMetadatum description: delete an existing metadatum operationId: deleteBusinessConnectorsConnectorMetadataMetadatum parameters: - name: resource-instance-id in: path description: Unique id of resource instance. required: true style: simple schema: type: string - name: metaname in: path description: '' required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /business/connectors/connector/{resource-instance-id}/metadata: get: tags: - Business summary: getBusinessConnectorsConnectorMetadata description: returns metadata operationId: getBusinessConnectorsConnectorMetadata parameters: - name: resource-instance-id in: path description: Unique id of resource instance. required: true style: simple schema: type: string - name: metaname in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/metadata' - description: Collection of metadatum (key/value pairs) default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /business/connectors/connector/{resource-instance-id}: get: tags: - Business summary: getBusinessConnectorsConnector description: returns connector operationId: getBusinessConnectorsConnector parameters: - name: resource-instance-id in: path description: Unique id of resource instance. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/connector1' - description: >- Collection of resource instances used to connect a variety of disparate inventory widgets ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Business summary: createOrUpdateBusinessConnectorsConnector description: > Create or update an existing connector. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateBusinessConnectorsConnector parameters: - name: resource-instance-id in: path description: Unique id of resource instance. required: true style: simple schema: type: string requestBody: description: connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessConnectorsConnector.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/connector' - description: connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessConnectorsConnector.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Business summary: UpdateBusinessConnectorsConnector description: > Update an existing connector # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateBusinessConnectorsConnector parameters: - name: resource-instance-id in: path description: Unique id of resource instance. required: true style: simple schema: type: string requestBody: description: connector object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/connector2' - description: connector object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Business summary: deleteBusinessConnectorsConnector description: delete an existing connector operationId: deleteBusinessConnectorsConnector parameters: - name: resource-instance-id in: path description: Unique id of resource instance. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /business/connectors: get: tags: - Business summary: getBusinessConnectors description: returns connectors operationId: getBusinessConnectors parameters: - name: resource-instance-id in: query description: '' style: form explode: true schema: type: string - name: model-invariant-id in: query description: '' style: form explode: true schema: type: string - name: model-version-id in: query description: '' style: form explode: true schema: type: string - name: widget-model-id in: query description: '' style: form explode: true schema: type: string - name: widget-model-version in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/connectors1' - description: Collection of resource instances used to connect a variety of disparate inventory widgets default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship : put: tags: - Business summary: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string - name: service-type in: path description: Value defined by orchestration to identify this service across ONAP. required: true style: simple schema: type: string - name: service-instance-id in: path description: Uniquely identifies this instance of a service required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Business summary: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship description: delete an existing relationship operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string - name: service-type in: path description: Value defined by orchestration to identify this service across ONAP. required: true style: simple schema: type: string - name: service-instance-id in: path description: Uniquely identifies this instance of a service required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname} : get: tags: - Business summary: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum description: returns metadatum operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string - name: service-type in: path description: Value defined by orchestration to identify this service across ONAP. required: true style: simple schema: type: string - name: service-instance-id in: path description: Uniquely identifies this instance of a service required: true style: simple schema: type: string - name: metaname in: path description: '' required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/metadatum' - description: >- Key/value pairs ###### Related Nodes - TO configuration (PARENT of metadatum, metadatum BelongsTo configuration, MANY2ONE)(4) - TO connector (PARENT of metadatum, metadatum BelongsTo connector, MANY2ONE)(4) - TO cp( metadatum AppliesTo cp, MANY2MANY) AAI-2154 For BBS Usecase - TO generic-vnf( metadatum AppliesTo generic-vnf, MANY2MANY) AAI-2154 For BBS Usecase - TO image (PARENT of metadatum, metadatum BelongsTo image, MANY2ONE)(4) - TO model-ver (PARENT of metadatum, metadatum BelongsTo model-ver, MANY2ONE)(4) - TO pnf( metadatum AppliesTo pnf, MANY2MANY) AAI-2154 For BBS Usecase - TO service-instance (PARENT of metadatum, metadatum BelongsTo service-instance, MANY2ONE)(4) -(4) IF this TO node is deleted, this METADATUM is DELETED also default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Business summary: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum description: > Create or update an existing metadatum. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string - name: service-type in: path description: Value defined by orchestration to identify this service across ONAP. required: true style: simple schema: type: string - name: service-instance-id in: path description: Uniquely identifies this instance of a service required: true style: simple schema: type: string - name: metaname in: path description: '' required: true style: simple schema: type: string requestBody: description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/metadatum' - description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Business summary: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum description: > Update an existing metadatum # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string - name: service-type in: path description: Value defined by orchestration to identify this service across ONAP. required: true style: simple schema: type: string - name: service-instance-id in: path description: Uniquely identifies this instance of a service required: true style: simple schema: type: string - name: metaname in: path description: '' required: true style: simple schema: type: string requestBody: description: metadatum object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/metadatum2' - description: metadatum object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Business summary: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum description: delete an existing metadatum operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string - name: service-type in: path description: Value defined by orchestration to identify this service across ONAP. required: true style: simple schema: type: string - name: service-instance-id in: path description: Uniquely identifies this instance of a service required: true style: simple schema: type: string - name: metaname in: path description: '' required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata : get: tags: - Business summary: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata description: returns metadata operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string - name: service-type in: path description: Value defined by orchestration to identify this service across ONAP. required: true style: simple schema: type: string - name: service-instance-id in: path description: Uniquely identifies this instance of a service required: true style: simple schema: type: string - name: metaname in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/metadata' - description: Collection of metadatum (key/value pairs) default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Business summary: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string - name: service-type in: path description: Value defined by orchestration to identify this service across ONAP. required: true style: simple schema: type: string - name: service-instance-id in: path description: Uniquely identifies this instance of a service required: true style: simple schema: type: string - name: id in: path description: Allotted Resource id UUID assigned to this instance. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Business summary: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship description: delete an existing relationship operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string - name: service-type in: path description: Value defined by orchestration to identify this service across ONAP. required: true style: simple schema: type: string - name: service-instance-id in: path description: Uniquely identifies this instance of a service required: true style: simple schema: type: string - name: id in: path description: Allotted Resource id UUID assigned to this instance. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - Business summary: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect description: returns tunnel-xconnect operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string - name: service-type in: path description: Value defined by orchestration to identify this service across ONAP. required: true style: simple schema: type: string - name: service-instance-id in: path description: Uniquely identifies this instance of a service required: true style: simple schema: type: string - name: id in: path description: Allotted Resource id UUID assigned to this instance. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel-xconnect1' - description: >- Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Business summary: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect description: > Create or update an existing tunnel-xconnect. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string - name: service-type in: path description: Value defined by orchestration to identify this service across ONAP. required: true style: simple schema: type: string - name: service-instance-id in: path description: Uniquely identifies this instance of a service required: true style: simple schema: type: string - name: id in: path description: Allotted Resource id UUID assigned to this instance. required: true style: simple schema: type: string requestBody: description: tunnel-xconnect object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel-xconnect' - description: tunnel-xconnect object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Business summary: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect description: > Update an existing tunnel-xconnect # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string - name: service-type in: path description: Value defined by orchestration to identify this service across ONAP. required: true style: simple schema: type: string - name: service-instance-id in: path description: Uniquely identifies this instance of a service required: true style: simple schema: type: string - name: id in: path description: Allotted Resource id UUID assigned to this instance. required: true style: simple schema: type: string requestBody: description: tunnel-xconnect object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel-xconnect2' - description: tunnel-xconnect object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Business summary: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect description: delete an existing tunnel-xconnect operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string - name: service-type in: path description: Value defined by orchestration to identify this service across ONAP. required: true style: simple schema: type: string - name: service-instance-id in: path description: Uniquely identifies this instance of a service required: true style: simple schema: type: string - name: id in: path description: Allotted Resource id UUID assigned to this instance. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : get: tags: - Business summary: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnects description: returns tunnel-xconnects operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnects parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string - name: service-type in: path description: Value defined by orchestration to identify this service across ONAP. required: true style: simple schema: type: string - name: service-instance-id in: path description: Uniquely identifies this instance of a service required: true style: simple schema: type: string - name: id in: path description: Allotted Resource id UUID assigned to this instance. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/tunnel-xconnects1' - description: This object is used to store the specific tunnel cross connect aspects of an allotted resource default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Business summary: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string - name: service-type in: path description: Value defined by orchestration to identify this service across ONAP. required: true style: simple schema: type: string - name: service-instance-id in: path description: Uniquely identifies this instance of a service required: true style: simple schema: type: string - name: id in: path description: Allotted Resource id UUID assigned to this instance. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Business summary: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship description: delete an existing relationship operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string - name: service-type in: path description: Value defined by orchestration to identify this service across ONAP. required: true style: simple schema: type: string - name: service-instance-id in: path description: Uniquely identifies this instance of a service required: true style: simple schema: type: string - name: id in: path description: Allotted Resource id UUID assigned to this instance. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id} : get: tags: - Business summary: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource description: returns allotted-resource operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string - name: service-type in: path description: Value defined by orchestration to identify this service across ONAP. required: true style: simple schema: type: string - name: service-instance-id in: path description: Uniquely identifies this instance of a service required: true style: simple schema: type: string - name: id in: path description: Allotted Resource id UUID assigned to this instance. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/allotted-resource1' - description: >- Represents a slice or partial piece of a resource that gets separately allotted ###### Related Nodes - TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE) AAI-1925 - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY) - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY) - TO l-interface( allotted-resource Uses l-interface, ONE2MANY) - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY) - TO network-policy( allotted-resource Uses network-policy, ONE2ONE) - TO p-interface( allotted-resource Uses p-interface, ONE2MANY) AAI-1925 For CCVPN Usecase - TO service-instance (PARENT of allotted-resource, allotted-resource BelongsTo service-instance, MANY2ONE)(4) - TO vlan( allotted-resource PartOf vlan, MANY2MANY) - TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY) - FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE) AAI-1925 - FROM configuration( configuration Uses allotted-resource, 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Business summary: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource description: > Create or update an existing allotted-resource. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string - name: service-type in: path description: Value defined by orchestration to identify this service across ONAP. required: true style: simple schema: type: string - name: service-instance-id in: path description: Uniquely identifies this instance of a service required: true style: simple schema: type: string - name: id in: path description: Allotted Resource id UUID assigned to this instance. required: true style: simple schema: type: string requestBody: description: allotted-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/allotted-resource' - description: allotted-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Business summary: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource description: > Update an existing allotted-resource # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string - name: service-type in: path description: Value defined by orchestration to identify this service across ONAP. required: true style: simple schema: type: string - name: service-instance-id in: path description: Uniquely identifies this instance of a service required: true style: simple schema: type: string - name: id in: path description: Allotted Resource id UUID assigned to this instance. required: true style: simple schema: type: string requestBody: description: allotted-resource object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/allotted-resource2' - description: allotted-resource object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Business summary: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource description: delete an existing allotted-resource operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string - name: service-type in: path description: Value defined by orchestration to identify this service across ONAP. required: true style: simple schema: type: string - name: service-instance-id in: path description: Uniquely identifies this instance of a service required: true style: simple schema: type: string - name: id in: path description: Allotted Resource id UUID assigned to this instance. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources : get: tags: - Business summary: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResources description: returns allotted-resources operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResources parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string - name: service-type in: path description: Value defined by orchestration to identify this service across ONAP. required: true style: simple schema: type: string - name: service-instance-id in: path description: Uniquely identifies this instance of a service required: true style: simple schema: type: string - name: id in: query description: '' style: form explode: true schema: type: string - name: model-invariant-id in: query description: '' style: form explode: true schema: type: string - name: model-version-id in: query description: '' style: form explode: true schema: type: string - name: type in: query description: '' style: form explode: true schema: type: string - name: role in: query description: '' style: form explode: true schema: type: string - name: allotted-resource-name in: query description: '' style: form explode: true schema: type: string - name: access-provider-id in: query description: '' style: form explode: true schema: type: string - name: access-client-id in: query description: '' style: form explode: true schema: type: string - name: access-topology-id in: query description: '' style: form explode: true schema: type: string - name: access-node-id in: query description: '' style: form explode: true schema: type: string - name: access-ltp-id in: query description: '' style: form explode: true schema: type: string - name: vpn-name in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/allotted-resources1' - description: This object is used to store slices of services being offered default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id} : get: tags: - Business summary: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance description: returns service-instance operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string - name: service-type in: path description: Value defined by orchestration to identify this service across ONAP. required: true style: simple schema: type: string - name: service-instance-id in: path description: Uniquely identifies this instance of a service required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/service-instance1' - description: >- Instance of a service ###### Related Nodes - 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 Uses instance-group, ONE2MANY) MSO creates this edge on VNF Group Service creation - TO instance-group( service-instance MemberOf instance-group, MANY2MANY) - TO l3-network( service-instance ComposedOf l3-network, 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, ONE2MANY) 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Business summary: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance description: > Create or update an existing service-instance. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string - name: service-type in: path description: Value defined by orchestration to identify this service across ONAP. required: true style: simple schema: type: string - name: service-instance-id in: path description: Uniquely identifies this instance of a service required: true style: simple schema: type: string requestBody: description: service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/service-instance' - description: service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Business summary: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance description: > Update an existing service-instance # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string - name: service-type in: path description: Value defined by orchestration to identify this service across ONAP. required: true style: simple schema: type: string - name: service-instance-id in: path description: Uniquely identifies this instance of a service required: true style: simple schema: type: string requestBody: description: service-instance object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/service-instance2' - description: service-instance object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Business summary: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance description: delete an existing service-instance operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string - name: service-type in: path description: Value defined by orchestration to identify this service across ONAP. required: true style: simple schema: type: string - name: service-instance-id in: path description: Uniquely identifies this instance of a service required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances: get: tags: - Business summary: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstances description: returns service-instances operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstances parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string - name: service-type in: path description: Value defined by orchestration to identify this service across ONAP. required: true style: simple schema: type: string - name: service-instance-id in: query description: '' style: form explode: true schema: type: string - name: service-instance-name in: query description: '' style: form explode: true schema: type: string - name: environment-context in: query description: '' style: form explode: true schema: type: string - name: workload-context in: query description: '' style: form explode: true schema: type: string - name: model-invariant-id in: query description: '' style: form explode: true schema: type: string - name: model-version-id in: query description: '' style: form explode: true schema: type: string - name: widget-model-id in: query description: '' style: form explode: true schema: type: string - name: widget-model-version in: query description: '' style: form explode: true schema: type: string - name: service-instance-location-id in: query description: '' style: form explode: true schema: type: string - name: orchestration-status in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/service-instances1' - description: Collection of service instances default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship : put: tags: - Business summary: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string - name: service-type in: path description: Value defined by orchestration to identify this service across ONAP. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Business summary: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship description: delete an existing relationship operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string - name: service-type in: path description: Value defined by orchestration to identify this service across ONAP. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}: get: tags: - Business summary: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscription description: returns service-subscription operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscription parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string - name: service-type in: path description: Value defined by orchestration to identify this service across ONAP. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/service-subscription1' - description: >- Object that group service instances. ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Business summary: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription description: > Create or update an existing service-subscription. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string - name: service-type in: path description: Value defined by orchestration to identify this service across ONAP. required: true style: simple schema: type: string requestBody: description: service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/service-subscription' - description: service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Business summary: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription description: > Update an existing service-subscription # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string - name: service-type in: path description: Value defined by orchestration to identify this service across ONAP. required: true style: simple schema: type: string requestBody: description: service-subscription object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/service-subscription2' - description: service-subscription object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Business summary: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscription description: delete an existing service-subscription operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscription parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string - name: service-type in: path description: Value defined by orchestration to identify this service across ONAP. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /business/customers/customer/{global-customer-id}/service-subscriptions: get: tags: - Business summary: getBusinessCustomersCustomerServiceSubscriptions description: returns service-subscriptions operationId: getBusinessCustomersCustomerServiceSubscriptions parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string - name: service-type in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/service-subscriptions1' - description: Collection of objects that group service instances. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /business/customers/customer/{global-customer-id}/relationship-list/relationship: put: tags: - Business summary: createOrUpdateBusinessCustomersCustomerRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateBusinessCustomersCustomerRelationshipListRelationship parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessCustomersCustomer.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessCustomersCustomer.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Business summary: deleteBusinessCustomersCustomerRelationshipListRelationship description: delete an existing relationship operationId: deleteBusinessCustomersCustomerRelationshipListRelationship parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /business/customers/customer/{global-customer-id}: get: tags: - Business summary: getBusinessCustomersCustomer description: returns customer operationId: getBusinessCustomersCustomer parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/customer1' - description: >- customer identifiers to provide linkage back to BSS information. ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Business summary: createOrUpdateBusinessCustomersCustomer description: > Create or update an existing customer. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateBusinessCustomersCustomer parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string requestBody: description: customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessCustomersCustomer.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/customer' - description: customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessCustomersCustomer.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Business summary: UpdateBusinessCustomersCustomer description: > Update an existing customer # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateBusinessCustomersCustomer parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string requestBody: description: customer object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/customer2' - description: customer object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Business summary: deleteBusinessCustomersCustomer description: delete an existing customer operationId: deleteBusinessCustomersCustomer parameters: - name: global-customer-id in: path description: Global customer id used across ONAP to uniquely identify customer. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /business/customers: get: tags: - Business summary: getBusinessCustomers description: returns customers operationId: getBusinessCustomers parameters: - name: global-customer-id in: query description: '' style: form explode: true schema: type: string - name: subscriber-name in: query description: '' style: form explode: true schema: type: string - name: subscriber-type in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/customers1' - description: Collection of customer identifiers to provide linkage back to BSS information. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship: put: tags: - Business summary: createOrUpdateBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship parameters: - name: line-of-business-name in: path description: Name of the line-of-business (product) required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessLinesOfBusinessLineOfBusiness.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessLinesOfBusinessLineOfBusiness.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Business summary: deleteBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship description: delete an existing relationship operationId: deleteBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship parameters: - name: line-of-business-name in: path description: Name of the line-of-business (product) required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /business/lines-of-business/line-of-business/{line-of-business-name}: get: tags: - Business summary: getBusinessLinesOfBusinessLineOfBusiness description: returns line-of-business operationId: getBusinessLinesOfBusinessLineOfBusiness parameters: - name: line-of-business-name in: path description: Name of the line-of-business (product) required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/line-of-business1' - description: >- describes a line-of-business ###### Related Nodes - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY) - TO l3-network( line-of-business Uses l3-network, MANY2MANY) default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Business summary: createOrUpdateBusinessLinesOfBusinessLineOfBusiness description: > Create or update an existing line-of-business. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusiness parameters: - name: line-of-business-name in: path description: Name of the line-of-business (product) required: true style: simple schema: type: string requestBody: description: line-of-business object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessLinesOfBusinessLineOfBusiness.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/line-of-business' - description: line-of-business object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessLinesOfBusinessLineOfBusiness.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Business summary: UpdateBusinessLinesOfBusinessLineOfBusiness description: > Update an existing line-of-business # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateBusinessLinesOfBusinessLineOfBusiness parameters: - name: line-of-business-name in: path description: Name of the line-of-business (product) required: true style: simple schema: type: string requestBody: description: line-of-business object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/line-of-business2' - description: line-of-business object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Business summary: deleteBusinessLinesOfBusinessLineOfBusiness description: delete an existing line-of-business operationId: deleteBusinessLinesOfBusinessLineOfBusiness parameters: - name: line-of-business-name in: path description: Name of the line-of-business (product) required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /business/lines-of-business: get: tags: - Business summary: getBusinessLinesOfBusiness description: returns lines-of-business operationId: getBusinessLinesOfBusiness parameters: - name: line-of-business-name in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/lines-of-business1' - description: Collection of lines-of-business default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship: put: tags: - Business summary: createOrUpdateBusinessOwningEntitiesOwningEntityRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateBusinessOwningEntitiesOwningEntityRelationshipListRelationship parameters: - name: owning-entity-id in: path description: UUID of an owning entity required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessOwningEntitiesOwningEntity.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessOwningEntitiesOwningEntity.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Business summary: deleteBusinessOwningEntitiesOwningEntityRelationshipListRelationship description: delete an existing relationship operationId: deleteBusinessOwningEntitiesOwningEntityRelationshipListRelationship parameters: - name: owning-entity-id in: path description: UUID of an owning entity required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /business/owning-entities/owning-entity/{owning-entity-id}: get: tags: - Business summary: getBusinessOwningEntitiesOwningEntity description: returns owning-entity operationId: getBusinessOwningEntitiesOwningEntity parameters: - name: owning-entity-id in: path description: UUID of an owning entity required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/owning-entity1' - description: >- describes an owning-entity ###### Related Nodes - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE) default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Business summary: createOrUpdateBusinessOwningEntitiesOwningEntity description: > Create or update an existing owning-entity. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateBusinessOwningEntitiesOwningEntity parameters: - name: owning-entity-id in: path description: UUID of an owning entity required: true style: simple schema: type: string requestBody: description: owning-entity object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessOwningEntitiesOwningEntity.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/owning-entity' - description: owning-entity object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessOwningEntitiesOwningEntity.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Business summary: UpdateBusinessOwningEntitiesOwningEntity description: > Update an existing owning-entity # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateBusinessOwningEntitiesOwningEntity parameters: - name: owning-entity-id in: path description: UUID of an owning entity required: true style: simple schema: type: string requestBody: description: owning-entity object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/owning-entity2' - description: owning-entity object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Business summary: deleteBusinessOwningEntitiesOwningEntity description: delete an existing owning-entity operationId: deleteBusinessOwningEntitiesOwningEntity parameters: - name: owning-entity-id in: path description: UUID of an owning entity required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /business/owning-entities: get: tags: - Business summary: getBusinessOwningEntities description: returns owning-entities operationId: getBusinessOwningEntities parameters: - name: owning-entity-id in: query description: '' style: form explode: true schema: type: string - name: owning-entity-name in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/owning-entities1' - description: Collection of owning-entities default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /business/platforms/platform/{platform-name}/relationship-list/relationship: put: tags: - Business summary: createOrUpdateBusinessPlatformsPlatformRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateBusinessPlatformsPlatformRelationshipListRelationship parameters: - name: platform-name in: path description: Name of the platform required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessPlatformsPlatform.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessPlatformsPlatform.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Business summary: deleteBusinessPlatformsPlatformRelationshipListRelationship description: delete an existing relationship operationId: deleteBusinessPlatformsPlatformRelationshipListRelationship parameters: - name: platform-name in: path description: Name of the platform required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /business/platforms/platform/{platform-name}: get: tags: - Business summary: getBusinessPlatformsPlatform description: returns platform operationId: getBusinessPlatformsPlatform parameters: - name: platform-name in: path description: Name of the platform required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/platform1' - description: >- describes a platform ###### Related Nodes - TO generic-vnf( platform Uses generic-vnf, MANY2MANY) - TO l3-network( platform Uses l3-network, MANY2MANY) default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Business summary: createOrUpdateBusinessPlatformsPlatform description: > Create or update an existing platform. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateBusinessPlatformsPlatform parameters: - name: platform-name in: path description: Name of the platform required: true style: simple schema: type: string requestBody: description: platform object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessPlatformsPlatform.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/platform' - description: platform object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessPlatformsPlatform.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Business summary: UpdateBusinessPlatformsPlatform description: > Update an existing platform # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateBusinessPlatformsPlatform parameters: - name: platform-name in: path description: Name of the platform required: true style: simple schema: type: string requestBody: description: platform object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/platform2' - description: platform object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Business summary: deleteBusinessPlatformsPlatform description: delete an existing platform operationId: deleteBusinessPlatformsPlatform parameters: - name: platform-name in: path description: Name of the platform required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /business/platforms: get: tags: - Business summary: getBusinessPlatforms description: returns platforms operationId: getBusinessPlatforms parameters: - name: platform-name in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/platforms1' - description: Collection of platforms default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /business/projects/project/{project-name}/relationship-list/relationship: put: tags: - Business summary: createOrUpdateBusinessProjectsProjectRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateBusinessProjectsProjectRelationshipListRelationship parameters: - name: project-name in: path description: Name of the project deploying a service required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessProjectsProject.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessProjectsProject.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Business summary: deleteBusinessProjectsProjectRelationshipListRelationship description: delete an existing relationship operationId: deleteBusinessProjectsProjectRelationshipListRelationship parameters: - name: project-name in: path description: Name of the project deploying a service required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /business/projects/project/{project-name}: get: tags: - Business summary: getBusinessProjectsProject description: returns project operationId: getBusinessProjectsProject parameters: - name: project-name in: path description: Name of the project deploying a service required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/project1' - description: >- describes the project ###### Related Nodes - TO service-instance( project Uses service-instance, ONE2MANY) default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Business summary: createOrUpdateBusinessProjectsProject description: > Create or update an existing project. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateBusinessProjectsProject parameters: - name: project-name in: path description: Name of the project deploying a service required: true style: simple schema: type: string requestBody: description: project object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessProjectsProject.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/project' - description: project object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessProjectsProject.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Business summary: UpdateBusinessProjectsProject description: > Update an existing project # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateBusinessProjectsProject parameters: - name: project-name in: path description: Name of the project deploying a service required: true style: simple schema: type: string requestBody: description: project object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/project2' - description: project object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Business summary: deleteBusinessProjectsProject description: delete an existing project operationId: deleteBusinessProjectsProject parameters: - name: project-name in: path description: Name of the project deploying a service required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /business/projects: get: tags: - Business summary: getBusinessProjects description: returns projects operationId: getBusinessProjects parameters: - name: project-name in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/projects1' - description: Collection of projects default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /business/sp-partners/sp-partner/{sp-partner-id}/relationship-list/relationship: put: tags: - Business summary: createOrUpdateBusinessSpPartnersSpPartnerRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateBusinessSpPartnersSpPartnerRelationshipListRelationship parameters: - name: sp-partner-id in: path description: Uniquely identifies this sp-partner by id required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessSpPartnersSpPartner.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessSpPartnersSpPartner.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Business summary: deleteBusinessSpPartnersSpPartnerRelationshipListRelationship description: delete an existing relationship operationId: deleteBusinessSpPartnersSpPartnerRelationshipListRelationship parameters: - name: sp-partner-id in: path description: Uniquely identifies this sp-partner by id required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /business/sp-partners/sp-partner/{sp-partner-id}: get: tags: - Business summary: getBusinessSpPartnersSpPartner description: returns sp-partner operationId: getBusinessSpPartnersSpPartner parameters: - name: sp-partner-id in: path description: Uniquely identifies this sp-partner by id required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sp-partner1' - description: >- Instance of an sp-partner ###### Related Nodes - TO service-instance( sp-partner PartOf service-instance, ONE2MANY) For CCVPN Usecase default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Business summary: createOrUpdateBusinessSpPartnersSpPartner description: > Create or update an existing sp-partner. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateBusinessSpPartnersSpPartner parameters: - name: sp-partner-id in: path description: Uniquely identifies this sp-partner by id required: true style: simple schema: type: string requestBody: description: sp-partner object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessSpPartnersSpPartner.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/sp-partner' - description: sp-partner object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/BusinessSpPartnersSpPartner.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Business summary: UpdateBusinessSpPartnersSpPartner description: > Update an existing sp-partner # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateBusinessSpPartnersSpPartner parameters: - name: sp-partner-id in: path description: Uniquely identifies this sp-partner by id required: true style: simple schema: type: string requestBody: description: sp-partner object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/sp-partner2' - description: sp-partner object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Business summary: deleteBusinessSpPartnersSpPartner description: delete an existing sp-partner operationId: deleteBusinessSpPartnersSpPartner parameters: - name: sp-partner-id in: path description: Uniquely identifies this sp-partner by id required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /business/sp-partners: get: tags: - Business summary: getBusinessSpPartners description: returns sp-partners operationId: getBusinessSpPartners parameters: - name: sp-partner-id in: query description: '' style: form explode: true schema: type: string - name: url in: query description: '' style: form explode: true schema: type: string - name: callsource in: query description: '' style: form explode: true schema: type: string - name: model-invariant-id in: query description: '' style: form explode: true schema: type: string - name: model-version-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sp-partners1' - description: Collection of sp-partners default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship: put: tags: - ServiceDesignAndCreation summary: createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship parameters: - name: vnf-image-uuid in: path description: Unique ID of this asset required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationVnfImagesVnfImage.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationVnfImagesVnfImage.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ServiceDesignAndCreation summary: deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship description: delete an existing relationship operationId: deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship parameters: - name: vnf-image-uuid in: path description: Unique ID of this asset required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}: get: tags: - ServiceDesignAndCreation summary: getServiceDesignAndCreationVnfImagesVnfImage description: returns vnf-image operationId: getServiceDesignAndCreationVnfImagesVnfImage parameters: - name: vnf-image-uuid in: path description: Unique ID of this asset required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/vnf-image1' - description: >- Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge. ###### Related Nodes - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE) -VNF-IMAGE cannot be deleted if related to GENERIC-VNF default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - ServiceDesignAndCreation summary: createOrUpdateServiceDesignAndCreationVnfImagesVnfImage description: > Create or update an existing vnf-image. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImage parameters: - name: vnf-image-uuid in: path description: Unique ID of this asset required: true style: simple schema: type: string requestBody: description: vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationVnfImagesVnfImage.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/vnf-image' - description: vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationVnfImagesVnfImage.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - ServiceDesignAndCreation summary: UpdateServiceDesignAndCreationVnfImagesVnfImage description: > Update an existing vnf-image # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateServiceDesignAndCreationVnfImagesVnfImage parameters: - name: vnf-image-uuid in: path description: Unique ID of this asset required: true style: simple schema: type: string requestBody: description: vnf-image object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/vnf-image2' - description: vnf-image object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ServiceDesignAndCreation summary: deleteServiceDesignAndCreationVnfImagesVnfImage description: delete an existing vnf-image operationId: deleteServiceDesignAndCreationVnfImagesVnfImage parameters: - name: vnf-image-uuid in: path description: Unique ID of this asset required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /service-design-and-creation/vnf-images: get: tags: - ServiceDesignAndCreation summary: getServiceDesignAndCreationVnfImages description: returns vnf-images operationId: getServiceDesignAndCreationVnfImages parameters: - name: vnf-image-uuid in: query description: '' style: form explode: true schema: type: string - name: application in: query description: '' style: form explode: true schema: type: string - name: application-vendor in: query description: '' style: form explode: true schema: type: string - name: application-version in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/vnf-images1' - description: Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /service-design-and-creation/services/service/{service-id}/relationship-list/relationship: put: tags: - ServiceDesignAndCreation summary: createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship parameters: - name: service-id in: path description: This gets defined by others to provide a unique ID for the service, we accept what is sent. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationServicesService.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationServicesService.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ServiceDesignAndCreation summary: deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship description: delete an existing relationship operationId: deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship parameters: - name: service-id in: path description: This gets defined by others to provide a unique ID for the service, we accept what is sent. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /service-design-and-creation/services/service/{service-id}: get: tags: - ServiceDesignAndCreation summary: getServiceDesignAndCreationServicesService description: returns service operationId: getServiceDesignAndCreationServicesService parameters: - name: service-id in: path description: This gets defined by others to provide a unique ID for the service, we accept what is sent. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/service1' - description: Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - ServiceDesignAndCreation summary: createOrUpdateServiceDesignAndCreationServicesService description: > Create or update an existing service. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateServiceDesignAndCreationServicesService parameters: - name: service-id in: path description: This gets defined by others to provide a unique ID for the service, we accept what is sent. required: true style: simple schema: type: string requestBody: description: service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationServicesService.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/service' - description: service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationServicesService.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - ServiceDesignAndCreation summary: UpdateServiceDesignAndCreationServicesService description: > Update an existing service # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateServiceDesignAndCreationServicesService parameters: - name: service-id in: path description: This gets defined by others to provide a unique ID for the service, we accept what is sent. required: true style: simple schema: type: string requestBody: description: service object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/service2' - description: service object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ServiceDesignAndCreation summary: deleteServiceDesignAndCreationServicesService description: delete an existing service operationId: deleteServiceDesignAndCreationServicesService parameters: - name: service-id in: path description: This gets defined by others to provide a unique ID for the service, we accept what is sent. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /service-design-and-creation/services: get: tags: - ServiceDesignAndCreation summary: getServiceDesignAndCreationServices description: returns services operationId: getServiceDesignAndCreationServices parameters: - name: service-id in: query description: '' style: form explode: true schema: type: string - name: service-description in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/services1' - description: Collection of service model definitions. Likely to be deprecated in favor of models from ASDC. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship: put: tags: - ServiceDesignAndCreation summary: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship parameters: - name: service-type in: path description: This gets defined by others to provide a unique ID for the service, we accept what is sent. required: true style: simple schema: type: string - name: vnf-type in: path description: String capturing type of vnf, that was intended to identify the SDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ONAP matures. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ServiceDesignAndCreation summary: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship description: delete an existing relationship operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship parameters: - name: service-type in: path description: This gets defined by others to provide a unique ID for the service, we accept what is sent. required: true style: simple schema: type: string - name: vnf-type in: path description: String capturing type of vnf, that was intended to identify the SDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ONAP matures. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}: get: tags: - ServiceDesignAndCreation summary: getServiceDesignAndCreationServiceCapabilitiesServiceCapability description: returns service-capability operationId: getServiceDesignAndCreationServiceCapabilitiesServiceCapability parameters: - name: service-type in: path description: This gets defined by others to provide a unique ID for the service, we accept what is sent. required: true style: simple schema: type: string - name: vnf-type in: path description: String capturing type of vnf, that was intended to identify the SDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ONAP matures. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/service-capability1' - description: >- Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this. ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - ServiceDesignAndCreation summary: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability description: > Create or update an existing service-capability. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability parameters: - name: service-type in: path description: This gets defined by others to provide a unique ID for the service, we accept what is sent. required: true style: simple schema: type: string - name: vnf-type in: path description: String capturing type of vnf, that was intended to identify the SDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ONAP matures. required: true style: simple schema: type: string requestBody: description: service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/service-capability' - description: service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - ServiceDesignAndCreation summary: UpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability description: > Update an existing service-capability # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability parameters: - name: service-type in: path description: This gets defined by others to provide a unique ID for the service, we accept what is sent. required: true style: simple schema: type: string - name: vnf-type in: path description: String capturing type of vnf, that was intended to identify the SDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ONAP matures. required: true style: simple schema: type: string requestBody: description: service-capability object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/service-capability2' - description: service-capability object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ServiceDesignAndCreation summary: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability description: delete an existing service-capability operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability parameters: - name: service-type in: path description: This gets defined by others to provide a unique ID for the service, we accept what is sent. required: true style: simple schema: type: string - name: vnf-type in: path description: String capturing type of vnf, that was intended to identify the SDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ONAP matures. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /service-design-and-creation/service-capabilities: get: tags: - ServiceDesignAndCreation summary: getServiceDesignAndCreationServiceCapabilities description: returns service-capabilities operationId: getServiceDesignAndCreationServiceCapabilities parameters: - name: service-type in: query description: '' style: form explode: true schema: type: string - name: vnf-type in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/service-capabilities1' - description: Collection of service capabilities. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - ServiceDesignAndCreation summary: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string - name: model-element-uuid in: path description: '' required: true style: simple schema: type: string - name: model-constraint-uuid in: path description: '' required: true style: simple schema: type: string - name: constrained-element-set-uuid in: path description: '' required: true style: simple schema: type: string - name: element-choice-set-uuid in: path description: '' required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ServiceDesignAndCreation summary: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship description: delete an existing relationship operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string - name: model-element-uuid in: path description: '' required: true style: simple schema: type: string - name: model-constraint-uuid in: path description: '' required: true style: simple schema: type: string - name: constrained-element-set-uuid in: path description: '' required: true style: simple schema: type: string - name: element-choice-set-uuid in: path description: '' required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - ServiceDesignAndCreation summary: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet description: returns element-choice-set operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string - name: model-element-uuid in: path description: '' required: true style: simple schema: type: string - name: model-constraint-uuid in: path description: '' required: true style: simple schema: type: string - name: constrained-element-set-uuid in: path description: '' required: true style: simple schema: type: string - name: element-choice-set-uuid in: path description: '' required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/element-choice-set1' - description: >- This is how we would capture constraints defining allowed sets of elements. ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - ServiceDesignAndCreation summary: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet description: > Create or update an existing element-choice-set. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string - name: model-element-uuid in: path description: '' required: true style: simple schema: type: string - name: model-constraint-uuid in: path description: '' required: true style: simple schema: type: string - name: constrained-element-set-uuid in: path description: '' required: true style: simple schema: type: string - name: element-choice-set-uuid in: path description: '' required: true style: simple schema: type: string requestBody: description: element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/element-choice-set' - description: element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - ServiceDesignAndCreation summary: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet description: > Update an existing element-choice-set # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string - name: model-element-uuid in: path description: '' required: true style: simple schema: type: string - name: model-constraint-uuid in: path description: '' required: true style: simple schema: type: string - name: constrained-element-set-uuid in: path description: '' required: true style: simple schema: type: string - name: element-choice-set-uuid in: path description: '' required: true style: simple schema: type: string requestBody: description: element-choice-set object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/element-choice-set2' - description: element-choice-set object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ServiceDesignAndCreation summary: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet description: delete an existing element-choice-set operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string - name: model-element-uuid in: path description: '' required: true style: simple schema: type: string - name: model-constraint-uuid in: path description: '' required: true style: simple schema: type: string - name: constrained-element-set-uuid in: path description: '' required: true style: simple schema: type: string - name: element-choice-set-uuid in: path description: '' required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : get: tags: - ServiceDesignAndCreation summary: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets description: returns element-choice-sets operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string - name: model-element-uuid in: path description: '' required: true style: simple schema: type: string - name: model-constraint-uuid in: path description: '' required: true style: simple schema: type: string - name: constrained-element-set-uuid in: path description: '' required: true style: simple schema: type: string - name: element-choice-set-uuid in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/element-choice-sets1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - ServiceDesignAndCreation summary: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string - name: model-element-uuid in: path description: '' required: true style: simple schema: type: string - name: model-constraint-uuid in: path description: '' required: true style: simple schema: type: string - name: constrained-element-set-uuid in: path description: '' required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ServiceDesignAndCreation summary: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship description: delete an existing relationship operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string - name: model-element-uuid in: path description: '' required: true style: simple schema: type: string - name: model-constraint-uuid in: path description: '' required: true style: simple schema: type: string - name: constrained-element-set-uuid in: path description: '' required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - ServiceDesignAndCreation summary: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet description: returns constrained-element-set operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string - name: model-element-uuid in: path description: '' required: true style: simple schema: type: string - name: model-constraint-uuid in: path description: '' required: true style: simple schema: type: string - name: constrained-element-set-uuid in: path description: '' required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/constrained-element-set1' - description: >- This is how we would capture constraints defining allowed sets of elements. ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - ServiceDesignAndCreation summary: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet description: > Create or update an existing constrained-element-set. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string - name: model-element-uuid in: path description: '' required: true style: simple schema: type: string - name: model-constraint-uuid in: path description: '' required: true style: simple schema: type: string - name: constrained-element-set-uuid in: path description: '' required: true style: simple schema: type: string requestBody: description: constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/constrained-element-set' - description: constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - ServiceDesignAndCreation summary: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet description: > Update an existing constrained-element-set # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string - name: model-element-uuid in: path description: '' required: true style: simple schema: type: string - name: model-constraint-uuid in: path description: '' required: true style: simple schema: type: string - name: constrained-element-set-uuid in: path description: '' required: true style: simple schema: type: string requestBody: description: constrained-element-set object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/constrained-element-set2' - description: constrained-element-set object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ServiceDesignAndCreation summary: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet description: delete an existing constrained-element-set operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string - name: model-element-uuid in: path description: '' required: true style: simple schema: type: string - name: model-constraint-uuid in: path description: '' required: true style: simple schema: type: string - name: constrained-element-set-uuid in: path description: '' required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : get: tags: - ServiceDesignAndCreation summary: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets description: returns constrained-element-sets operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string - name: model-element-uuid in: path description: '' required: true style: simple schema: type: string - name: model-constraint-uuid in: path description: '' required: true style: simple schema: type: string - name: constrained-element-set-uuid in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/constrained-element-sets1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - ServiceDesignAndCreation summary: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint description: returns model-constraint operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string - name: model-element-uuid in: path description: '' required: true style: simple schema: type: string - name: model-constraint-uuid in: path description: '' required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/model-constraint1' - description: >- This is how we would capture constraints defining allowed sets of elements. ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - ServiceDesignAndCreation summary: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint description: > Create or update an existing model-constraint. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string - name: model-element-uuid in: path description: '' required: true style: simple schema: type: string - name: model-constraint-uuid in: path description: '' required: true style: simple schema: type: string requestBody: description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/model-constraint' - description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - ServiceDesignAndCreation summary: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint description: > Update an existing model-constraint # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string - name: model-element-uuid in: path description: '' required: true style: simple schema: type: string - name: model-constraint-uuid in: path description: '' required: true style: simple schema: type: string requestBody: description: model-constraint object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/model-constraint2' - description: model-constraint object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ServiceDesignAndCreation summary: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint description: delete an existing model-constraint operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string - name: model-element-uuid in: path description: '' required: true style: simple schema: type: string - name: model-constraint-uuid in: path description: '' required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : get: tags: - ServiceDesignAndCreation summary: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints description: returns model-constraints operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string - name: model-element-uuid in: path description: '' required: true style: simple schema: type: string - name: model-constraint-uuid in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/model-constraints1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - ServiceDesignAndCreation summary: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string - name: model-element-uuid in: path description: '' required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ServiceDesignAndCreation summary: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship description: delete an existing relationship operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string - name: model-element-uuid in: path description: '' required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid} : get: tags: - ServiceDesignAndCreation summary: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement description: returns model-element operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string - name: model-element-uuid in: path description: '' required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/model-element1' - description: >- Defines how other models combine to make up a higher-level model. ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - ServiceDesignAndCreation summary: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement description: > Create or update an existing model-element. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string - name: model-element-uuid in: path description: '' required: true style: simple schema: type: string requestBody: description: model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/model-element' - description: model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - ServiceDesignAndCreation summary: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement description: > Update an existing model-element # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string - name: model-element-uuid in: path description: '' required: true style: simple schema: type: string requestBody: description: model-element object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/model-element2' - description: model-element object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ServiceDesignAndCreation summary: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement description: delete an existing model-element operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string - name: model-element-uuid in: path description: '' required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements: get: tags: - ServiceDesignAndCreation summary: getServiceDesignAndCreationModelsModelModelVersModelVerModelElements description: returns model-elements operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElements parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string - name: model-element-uuid in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/model-elements1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname} : get: tags: - ServiceDesignAndCreation summary: getServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum description: returns metadatum operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string - name: metaname in: path description: '' required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/metadatum' - description: >- Key/value pairs ###### Related Nodes - TO configuration (PARENT of metadatum, metadatum BelongsTo configuration, MANY2ONE)(4) - TO connector (PARENT of metadatum, metadatum BelongsTo connector, MANY2ONE)(4) - TO cp( metadatum AppliesTo cp, MANY2MANY) AAI-2154 For BBS Usecase - TO generic-vnf( metadatum AppliesTo generic-vnf, MANY2MANY) AAI-2154 For BBS Usecase - TO image (PARENT of metadatum, metadatum BelongsTo image, MANY2ONE)(4) - TO model-ver (PARENT of metadatum, metadatum BelongsTo model-ver, MANY2ONE)(4) - TO pnf( metadatum AppliesTo pnf, MANY2MANY) AAI-2154 For BBS Usecase - TO service-instance (PARENT of metadatum, metadatum BelongsTo service-instance, MANY2ONE)(4) -(4) IF this TO node is deleted, this METADATUM is DELETED also default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - ServiceDesignAndCreation summary: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum description: > Create or update an existing metadatum. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string - name: metaname in: path description: '' required: true style: simple schema: type: string requestBody: description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/metadatum' - description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - ServiceDesignAndCreation summary: UpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum description: > Update an existing metadatum # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string - name: metaname in: path description: '' required: true style: simple schema: type: string requestBody: description: metadatum object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/metadatum2' - description: metadatum object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ServiceDesignAndCreation summary: deleteServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum description: delete an existing metadatum operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string - name: metaname in: path description: '' required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata: get: tags: - ServiceDesignAndCreation summary: getServiceDesignAndCreationModelsModelModelVersModelVerMetadata description: returns metadata operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadata parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string - name: metaname in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/metadata' - description: Collection of metadatum (key/value pairs) default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship : put: tags: - ServiceDesignAndCreation summary: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModelModelVersModelVer.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModelModelVersModelVer.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ServiceDesignAndCreation summary: deleteServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship description: delete an existing relationship operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}: get: tags: - ServiceDesignAndCreation summary: getServiceDesignAndCreationModelsModelModelVersModelVer description: returns model-ver operationId: getServiceDesignAndCreationModelsModelModelVersModelVer parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/model-ver1' - description: >- Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - ServiceDesignAndCreation summary: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVer description: > Create or update an existing model-ver. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVer parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string requestBody: description: model-ver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModelModelVersModelVer.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/model-ver' - description: model-ver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModelModelVersModelVer.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - ServiceDesignAndCreation summary: UpdateServiceDesignAndCreationModelsModelModelVersModelVer description: > Update an existing model-ver # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVer parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string requestBody: description: model-ver object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/model-ver2' - description: model-ver object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ServiceDesignAndCreation summary: deleteServiceDesignAndCreationModelsModelModelVersModelVer description: delete an existing model-ver operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVer parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: path description: Unique identifier corresponding to one version of a model in ASDC required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /service-design-and-creation/models/model/{model-invariant-id}/model-vers: get: tags: - ServiceDesignAndCreation summary: getServiceDesignAndCreationModelsModelModelVers description: returns model-vers operationId: getServiceDesignAndCreationModelsModelModelVers parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: model-version-id in: query description: '' style: form explode: true schema: type: string - name: model-name in: query description: '' style: form explode: true schema: type: string - name: model-version in: query description: '' style: form explode: true schema: type: string - name: distribution-status in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/model-vers1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship: put: tags: - ServiceDesignAndCreation summary: createOrUpdateServiceDesignAndCreationModelsModelRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateServiceDesignAndCreationModelsModelRelationshipListRelationship parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModel.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModel.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ServiceDesignAndCreation summary: deleteServiceDesignAndCreationModelsModelRelationshipListRelationship description: delete an existing relationship operationId: deleteServiceDesignAndCreationModelsModelRelationshipListRelationship parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /service-design-and-creation/models/model/{model-invariant-id}: get: tags: - ServiceDesignAndCreation summary: getServiceDesignAndCreationModelsModel description: returns model operationId: getServiceDesignAndCreationModelsModel parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/model1' - description: >- Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - ServiceDesignAndCreation summary: createOrUpdateServiceDesignAndCreationModelsModel description: > Create or update an existing model. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateServiceDesignAndCreationModelsModel parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string requestBody: description: model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModel.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/model' - description: model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationModelsModel.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - ServiceDesignAndCreation summary: UpdateServiceDesignAndCreationModelsModel description: > Update an existing model # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateServiceDesignAndCreationModelsModel parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string requestBody: description: model object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/model2' - description: model object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ServiceDesignAndCreation summary: deleteServiceDesignAndCreationModelsModel description: delete an existing model operationId: deleteServiceDesignAndCreationModelsModel parameters: - name: model-invariant-id in: path description: Unique identifier corresponding to the main definition of a model in ASDC required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /service-design-and-creation/models: get: tags: - ServiceDesignAndCreation summary: getServiceDesignAndCreationModels description: returns models operationId: getServiceDesignAndCreationModels parameters: - name: model-invariant-id in: query description: '' style: form explode: true schema: type: string - name: model-type in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/models1' - description: Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - ServiceDesignAndCreation summary: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship parameters: - name: named-query-uuid in: path description: '' required: true style: simple schema: type: string - name: named-query-element-uuid in: path description: '' required: true style: simple schema: type: string - name: related-lookup-uuid in: path description: '' required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ServiceDesignAndCreation summary: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship description: delete an existing relationship operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship parameters: - name: named-query-uuid in: path description: '' required: true style: simple schema: type: string - name: named-query-element-uuid in: path description: '' required: true style: simple schema: type: string - name: related-lookup-uuid in: path description: '' required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - ServiceDesignAndCreation summary: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup description: returns related-lookup operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup parameters: - name: named-query-uuid in: path description: '' required: true style: simple schema: type: string - name: named-query-element-uuid in: path description: '' required: true style: simple schema: type: string - name: related-lookup-uuid in: path description: '' required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/related-lookup1' - description: >- TBD ###### Related Nodes - TO named-query-element (PARENT of related-lookup, related-lookup BelongsTo named-query-element, MANY2ONE)(4) -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - ServiceDesignAndCreation summary: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup description: > Create or update an existing related-lookup. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup parameters: - name: named-query-uuid in: path description: '' required: true style: simple schema: type: string - name: named-query-element-uuid in: path description: '' required: true style: simple schema: type: string - name: related-lookup-uuid in: path description: '' required: true style: simple schema: type: string requestBody: description: related-lookup object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/related-lookup' - description: related-lookup object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - ServiceDesignAndCreation summary: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup description: > Update an existing related-lookup # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup parameters: - name: named-query-uuid in: path description: '' required: true style: simple schema: type: string - name: named-query-element-uuid in: path description: '' required: true style: simple schema: type: string - name: related-lookup-uuid in: path description: '' required: true style: simple schema: type: string requestBody: description: related-lookup object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/related-lookup2' - description: related-lookup object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ServiceDesignAndCreation summary: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup description: delete an existing related-lookup operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup parameters: - name: named-query-uuid in: path description: '' required: true style: simple schema: type: string - name: named-query-element-uuid in: path description: '' required: true style: simple schema: type: string - name: related-lookup-uuid in: path description: '' required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups : get: tags: - ServiceDesignAndCreation summary: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookups description: returns related-lookups operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookups parameters: - name: named-query-uuid in: path description: '' required: true style: simple schema: type: string - name: named-query-element-uuid in: path description: '' required: true style: simple schema: type: string - name: related-lookup-uuid in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/related-lookups1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - ServiceDesignAndCreation summary: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint description: returns property-constraint operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint parameters: - name: named-query-uuid in: path description: '' required: true style: simple schema: type: string - name: named-query-element-uuid in: path description: '' required: true style: simple schema: type: string - name: property-constraint-uuid in: path description: '' required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/property-constraint' - description: >- TBD ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - ServiceDesignAndCreation summary: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint description: > Create or update an existing property-constraint. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint parameters: - name: named-query-uuid in: path description: '' required: true style: simple schema: type: string - name: named-query-element-uuid in: path description: '' required: true style: simple schema: type: string - name: property-constraint-uuid in: path description: '' required: true style: simple schema: type: string requestBody: description: property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/property-constraint' - description: property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - ServiceDesignAndCreation summary: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint description: > Update an existing property-constraint # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint parameters: - name: named-query-uuid in: path description: '' required: true style: simple schema: type: string - name: named-query-element-uuid in: path description: '' required: true style: simple schema: type: string - name: property-constraint-uuid in: path description: '' required: true style: simple schema: type: string requestBody: description: property-constraint object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/property-constraint2' - description: property-constraint object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ServiceDesignAndCreation summary: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint description: delete an existing property-constraint operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint parameters: - name: named-query-uuid in: path description: '' required: true style: simple schema: type: string - name: named-query-element-uuid in: path description: '' required: true style: simple schema: type: string - name: property-constraint-uuid in: path description: '' required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints : get: tags: - ServiceDesignAndCreation summary: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraints description: returns property-constraints operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraints parameters: - name: named-query-uuid in: path description: '' required: true style: simple schema: type: string - name: named-query-element-uuid in: path description: '' required: true style: simple schema: type: string - name: property-constraint-uuid in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/property-constraints' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship : put: tags: - ServiceDesignAndCreation summary: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship parameters: - name: named-query-uuid in: path description: '' required: true style: simple schema: type: string - name: named-query-element-uuid in: path description: '' required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ServiceDesignAndCreation summary: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship description: delete an existing relationship operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship parameters: - name: named-query-uuid in: path description: '' required: true style: simple schema: type: string - name: named-query-element-uuid in: path description: '' required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid} : get: tags: - ServiceDesignAndCreation summary: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement description: returns named-query-element operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement parameters: - name: named-query-uuid in: path description: '' required: true style: simple schema: type: string - name: named-query-element-uuid in: path description: '' required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/named-query-element1' - description: >- TBD ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - ServiceDesignAndCreation summary: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement description: > Create or update an existing named-query-element. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement parameters: - name: named-query-uuid in: path description: '' required: true style: simple schema: type: string - name: named-query-element-uuid in: path description: '' required: true style: simple schema: type: string requestBody: description: named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/named-query-element' - description: named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - ServiceDesignAndCreation summary: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement description: > Update an existing named-query-element # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement parameters: - name: named-query-uuid in: path description: '' required: true style: simple schema: type: string - name: named-query-element-uuid in: path description: '' required: true style: simple schema: type: string requestBody: description: named-query-element object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/named-query-element2' - description: named-query-element object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ServiceDesignAndCreation summary: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement description: delete an existing named-query-element operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement parameters: - name: named-query-uuid in: path description: '' required: true style: simple schema: type: string - name: named-query-element-uuid in: path description: '' required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements: get: tags: - ServiceDesignAndCreation summary: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElements description: returns named-query-elements operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElements parameters: - name: named-query-uuid in: path description: '' required: true style: simple schema: type: string - name: named-query-element-uuid in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/named-query-elements1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship: put: tags: - ServiceDesignAndCreation summary: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship parameters: - name: named-query-uuid in: path description: '' required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationNamedQueriesNamedQuery.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationNamedQueriesNamedQuery.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ServiceDesignAndCreation summary: deleteServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship description: delete an existing relationship operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship parameters: - name: named-query-uuid in: path description: '' required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /service-design-and-creation/named-queries/named-query/{named-query-uuid}: get: tags: - ServiceDesignAndCreation summary: getServiceDesignAndCreationNamedQueriesNamedQuery description: returns named-query operationId: getServiceDesignAndCreationNamedQueriesNamedQuery parameters: - name: named-query-uuid in: path description: '' required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/named-query1' - description: >- TBD ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - ServiceDesignAndCreation summary: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQuery description: > Create or update an existing named-query. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQuery parameters: - name: named-query-uuid in: path description: '' required: true style: simple schema: type: string requestBody: description: named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationNamedQueriesNamedQuery.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/named-query' - description: named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/ServiceDesignAndCreationNamedQueriesNamedQuery.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - ServiceDesignAndCreation summary: UpdateServiceDesignAndCreationNamedQueriesNamedQuery description: > Update an existing named-query # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQuery parameters: - name: named-query-uuid in: path description: '' required: true style: simple schema: type: string requestBody: description: named-query object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/named-query2' - description: named-query object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - ServiceDesignAndCreation summary: deleteServiceDesignAndCreationNamedQueriesNamedQuery description: delete an existing named-query operationId: deleteServiceDesignAndCreationNamedQueriesNamedQuery parameters: - name: named-query-uuid in: path description: '' required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /service-design-and-creation/named-queries: get: tags: - ServiceDesignAndCreation summary: getServiceDesignAndCreationNamedQueries description: returns named-queries operationId: getServiceDesignAndCreationNamedQueries parameters: - name: named-query-uuid in: query description: '' style: form explode: true schema: type: string - name: named-query-name in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/named-queries1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/logical-links/logical-link/{link-name}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkLogicalLinksLogicalLinkRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkLogicalLinksLogicalLinkRelationshipListRelationship parameters: - name: link-name in: path description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkLogicalLinksLogicalLink.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkLogicalLinksLogicalLink.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkLogicalLinksLogicalLinkRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkLogicalLinksLogicalLinkRelationshipListRelationship parameters: - name: link-name in: path description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/logical-links/logical-link/{link-name}: get: tags: - Network summary: getNetworkLogicalLinksLogicalLink description: returns logical-link operationId: getNetworkLogicalLinksLogicalLink parameters: - name: link-name in: path description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/logical-link1' - description: >- Logical links generally connect l-interfaces but are used to express logical connectivity between two points ###### Related Nodes - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY) - TO ext-aai-network( logical-link BelongsTo ext-aai-network, MANY2MANY) For CCVPN Usecase(2) - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY) - TO l-interface( logical-link Source l-interface, MANY2MANY)(4) - TO l-interface( logical-link Destination l-interface, MANY2MANY)(4) - TO lag-link( logical-link Uses lag-link, MANY2MANY) - TO logical-link( logical-link Uses logical-link, MANY2MANY) - TO pnf( logical-link BridgedTo pnf, MANY2MANY) - TO pserver( logical-link BridgedTo pserver, MANY2MANY) - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY) - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY) - FROM configuration( configuration Uses logical-link, ONE2MANY)(3) - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3) - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3) - FROM logical-link( logical-link Uses logical-link, MANY2MANY) - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE) - FROM service-instance( service-instance Uses logical-link, MANY2MANY)(3) - FROM vlan( vlan Uses logical-link, MANY2MANY)(3) -(2) IF this LOGICAL-LINK node is deleted, this TO node is DELETED also -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also -(4) IF this TO node is deleted, this LOGICAL-LINK is DELETED also default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkLogicalLinksLogicalLink description: > Create or update an existing logical-link. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkLogicalLinksLogicalLink parameters: - name: link-name in: path description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ required: true style: simple schema: type: string requestBody: description: logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkLogicalLinksLogicalLink.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/logical-link' - description: logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkLogicalLinksLogicalLink.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkLogicalLinksLogicalLink description: > Update an existing logical-link # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkLogicalLinksLogicalLink parameters: - name: link-name in: path description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ required: true style: simple schema: type: string requestBody: description: logical-link object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/logical-link2' - description: logical-link object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkLogicalLinksLogicalLink description: delete an existing logical-link operationId: deleteNetworkLogicalLinksLogicalLink parameters: - name: link-name in: path description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/logical-links: get: tags: - Network summary: getNetworkLogicalLinks description: returns logical-links operationId: getNetworkLogicalLinks parameters: - name: link-name in: query description: '' style: form explode: true schema: type: string - name: model-invariant-id in: query description: '' style: form explode: true schema: type: string - name: model-version-id in: query description: '' style: form explode: true schema: type: string - name: widget-model-id in: query description: '' style: form explode: true schema: type: string - name: widget-model-version in: query description: '' style: form explode: true schema: type: string - name: operational-status in: query description: '' style: form explode: true schema: type: string - name: prov-status in: query description: '' style: form explode: true schema: type: string - name: link-id in: query description: '' style: form explode: true schema: type: string - name: circuit-id in: query description: '' style: form explode: true schema: type: string - name: purpose in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/logical-links1' - description: Collection of logical connections default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship parameters: - name: site-pair-set-id in: path description: Unique id of site pair set. required: true style: simple schema: type: string - name: routing-instance-id in: path description: Unique id of routing instance required: true style: simple schema: type: string - name: site-pair-id in: path description: unique identifier of probe required: true style: simple schema: type: string - name: cos in: path description: unique identifier of probe required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship parameters: - name: site-pair-set-id in: path description: Unique id of site pair set. required: true style: simple schema: type: string - name: routing-instance-id in: path description: Unique id of routing instance required: true style: simple schema: type: string - name: site-pair-id in: path description: unique identifier of probe required: true style: simple schema: type: string - name: cos in: path description: unique identifier of probe required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - Network summary: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService description: returns class-of-service operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService parameters: - name: site-pair-set-id in: path description: Unique id of site pair set. required: true style: simple schema: type: string - name: routing-instance-id in: path description: Unique id of routing instance required: true style: simple schema: type: string - name: site-pair-id in: path description: unique identifier of probe required: true style: simple schema: type: string - name: cos in: path description: unique identifier of probe required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/class-of-service1' - description: >- ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService description: > Create or update an existing class-of-service. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService parameters: - name: site-pair-set-id in: path description: Unique id of site pair set. required: true style: simple schema: type: string - name: routing-instance-id in: path description: Unique id of routing instance required: true style: simple schema: type: string - name: site-pair-id in: path description: unique identifier of probe required: true style: simple schema: type: string - name: cos in: path description: unique identifier of probe required: true style: simple schema: type: string requestBody: description: class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/class-of-service' - description: class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService description: > Update an existing class-of-service # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService parameters: - name: site-pair-set-id in: path description: Unique id of site pair set. required: true style: simple schema: type: string - name: routing-instance-id in: path description: Unique id of routing instance required: true style: simple schema: type: string - name: site-pair-id in: path description: unique identifier of probe required: true style: simple schema: type: string - name: cos in: path description: unique identifier of probe required: true style: simple schema: type: string requestBody: description: class-of-service object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/class-of-service2' - description: class-of-service object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService description: delete an existing class-of-service operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService parameters: - name: site-pair-set-id in: path description: Unique id of site pair set. required: true style: simple schema: type: string - name: routing-instance-id in: path description: Unique id of routing instance required: true style: simple schema: type: string - name: site-pair-id in: path description: unique identifier of probe required: true style: simple schema: type: string - name: cos in: path description: unique identifier of probe required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : get: tags: - Network summary: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService description: returns classes-of-service operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService parameters: - name: site-pair-set-id in: path description: Unique id of site pair set. required: true style: simple schema: type: string - name: routing-instance-id in: path description: Unique id of routing instance required: true style: simple schema: type: string - name: site-pair-id in: path description: unique identifier of probe required: true style: simple schema: type: string - name: cos in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/classes-of-service1' - description: class-of-service of probe default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship parameters: - name: site-pair-set-id in: path description: Unique id of site pair set. required: true style: simple schema: type: string - name: routing-instance-id in: path description: Unique id of routing instance required: true style: simple schema: type: string - name: site-pair-id in: path description: unique identifier of probe required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship parameters: - name: site-pair-set-id in: path description: Unique id of site pair set. required: true style: simple schema: type: string - name: routing-instance-id in: path description: Unique id of routing instance required: true style: simple schema: type: string - name: site-pair-id in: path description: unique identifier of probe required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - Network summary: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair description: returns site-pair operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair parameters: - name: site-pair-set-id in: path description: Unique id of site pair set. required: true style: simple schema: type: string - name: routing-instance-id in: path description: Unique id of routing instance required: true style: simple schema: type: string - name: site-pair-id in: path description: unique identifier of probe required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/site-pair1' - description: >- ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair description: > Create or update an existing site-pair. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair parameters: - name: site-pair-set-id in: path description: Unique id of site pair set. required: true style: simple schema: type: string - name: routing-instance-id in: path description: Unique id of routing instance required: true style: simple schema: type: string - name: site-pair-id in: path description: unique identifier of probe required: true style: simple schema: type: string requestBody: description: site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/site-pair' - description: site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair description: > Update an existing site-pair # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair parameters: - name: site-pair-set-id in: path description: Unique id of site pair set. required: true style: simple schema: type: string - name: routing-instance-id in: path description: Unique id of routing instance required: true style: simple schema: type: string - name: site-pair-id in: path description: unique identifier of probe required: true style: simple schema: type: string requestBody: description: site-pair object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/site-pair2' - description: site-pair object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair description: delete an existing site-pair operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair parameters: - name: site-pair-set-id in: path description: Unique id of site pair set. required: true style: simple schema: type: string - name: routing-instance-id in: path description: Unique id of routing instance required: true style: simple schema: type: string - name: site-pair-id in: path description: unique identifier of probe required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs: get: tags: - Network summary: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairs description: returns site-pairs operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairs parameters: - name: site-pair-set-id in: path description: Unique id of site pair set. required: true style: simple schema: type: string - name: routing-instance-id in: path description: Unique id of routing instance required: true style: simple schema: type: string - name: site-pair-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/site-pairs1' - description: probe within a set default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship : put: tags: - Network summary: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship parameters: - name: site-pair-set-id in: path description: Unique id of site pair set. required: true style: simple schema: type: string - name: routing-instance-id in: path description: Unique id of routing instance required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship parameters: - name: site-pair-set-id in: path description: Unique id of site pair set. required: true style: simple schema: type: string - name: routing-instance-id in: path description: Unique id of routing instance required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}: get: tags: - Network summary: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance description: returns routing-instance operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance parameters: - name: site-pair-set-id in: path description: Unique id of site pair set. required: true style: simple schema: type: string - name: routing-instance-id in: path description: Unique id of routing instance required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/routing-instance1' - description: >- ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance description: > Create or update an existing routing-instance. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance parameters: - name: site-pair-set-id in: path description: Unique id of site pair set. required: true style: simple schema: type: string - name: routing-instance-id in: path description: Unique id of routing instance required: true style: simple schema: type: string requestBody: description: routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/routing-instance' - description: routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance description: > Update an existing routing-instance # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance parameters: - name: site-pair-set-id in: path description: Unique id of site pair set. required: true style: simple schema: type: string - name: routing-instance-id in: path description: Unique id of routing instance required: true style: simple schema: type: string requestBody: description: routing-instance object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/routing-instance2' - description: routing-instance object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance description: delete an existing routing-instance operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance parameters: - name: site-pair-set-id in: path description: Unique id of site pair set. required: true style: simple schema: type: string - name: routing-instance-id in: path description: Unique id of routing instance required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances: get: tags: - Network summary: getNetworkSitePairSetsSitePairSetRoutingInstances description: returns routing-instances operationId: getNetworkSitePairSetsSitePairSetRoutingInstances parameters: - name: site-pair-set-id in: path description: Unique id of site pair set. required: true style: simple schema: type: string - name: routing-instance-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/routing-instances1' - description: set of probes related to generic-vnf routing instance default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkSitePairSetsSitePairSetRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkSitePairSetsSitePairSetRelationshipListRelationship parameters: - name: site-pair-set-id in: path description: Unique id of site pair set. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSitePairSetsSitePairSet.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSitePairSetsSitePairSet.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkSitePairSetsSitePairSetRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkSitePairSetsSitePairSetRelationshipListRelationship parameters: - name: site-pair-set-id in: path description: Unique id of site pair set. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/site-pair-sets/site-pair-set/{site-pair-set-id}: get: tags: - Network summary: getNetworkSitePairSetsSitePairSet description: returns site-pair-set operationId: getNetworkSitePairSetsSitePairSet parameters: - name: site-pair-set-id in: path description: Unique id of site pair set. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/site-pair-set1' - description: >- Set of instances for probes used to measure service level agreements ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkSitePairSetsSitePairSet description: > Create or update an existing site-pair-set. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkSitePairSetsSitePairSet parameters: - name: site-pair-set-id in: path description: Unique id of site pair set. required: true style: simple schema: type: string requestBody: description: site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSitePairSetsSitePairSet.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/site-pair-set' - description: site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSitePairSetsSitePairSet.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkSitePairSetsSitePairSet description: > Update an existing site-pair-set # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkSitePairSetsSitePairSet parameters: - name: site-pair-set-id in: path description: Unique id of site pair set. required: true style: simple schema: type: string requestBody: description: site-pair-set object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/site-pair-set2' - description: site-pair-set object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkSitePairSetsSitePairSet description: delete an existing site-pair-set operationId: deleteNetworkSitePairSetsSitePairSet parameters: - name: site-pair-set-id in: path description: Unique id of site pair set. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/site-pair-sets: get: tags: - Network summary: getNetworkSitePairSets description: returns site-pair-sets operationId: getNetworkSitePairSets parameters: - name: site-pair-set-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/site-pair-sets1' - description: Collection of sets of instances for probes related to generic-vnf default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship : put: tags: - Network summary: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship parameters: - name: vpn-id in: path description: VPN ID, globally unique within A&AI required: true style: simple schema: type: string - name: global-route-target in: path description: Number used to identify an RT, globally unique in the network required: true style: simple schema: type: string - name: route-target-role in: path description: Role assigned to this route target required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship parameters: - name: vpn-id in: path description: VPN ID, globally unique within A&AI required: true style: simple schema: type: string - name: global-route-target in: path description: Number used to identify an RT, globally unique in the network required: true style: simple schema: type: string - name: route-target-role in: path description: Role assigned to this route target required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}: get: tags: - Network summary: getNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget description: returns route-target operationId: getNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget parameters: - name: vpn-id in: path description: VPN ID, globally unique within A&AI required: true style: simple schema: type: string - name: global-route-target in: path description: Number used to identify an RT, globally unique in the network required: true style: simple schema: type: string - name: route-target-role in: path description: Role assigned to this route target required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/route-target1' - description: >- Route target information ###### Related Nodes - TO vpn-binding (PARENT of route-target, route-target BelongsTo vpn-binding, MANY2ONE)(4) - TO vrf (PARENT of route-target, route-target BelongsTo vrf, MANY2ONE)(4) -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget description: > Create or update an existing route-target. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget parameters: - name: vpn-id in: path description: VPN ID, globally unique within A&AI required: true style: simple schema: type: string - name: global-route-target in: path description: Number used to identify an RT, globally unique in the network required: true style: simple schema: type: string - name: route-target-role in: path description: Role assigned to this route target required: true style: simple schema: type: string requestBody: description: route-target object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/route-target' - description: route-target object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget description: > Update an existing route-target # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget parameters: - name: vpn-id in: path description: VPN ID, globally unique within A&AI required: true style: simple schema: type: string - name: global-route-target in: path description: Number used to identify an RT, globally unique in the network required: true style: simple schema: type: string - name: route-target-role in: path description: Role assigned to this route target required: true style: simple schema: type: string requestBody: description: route-target object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/route-target2' - description: route-target object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget description: delete an existing route-target operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget parameters: - name: vpn-id in: path description: VPN ID, globally unique within A&AI required: true style: simple schema: type: string - name: global-route-target in: path description: Number used to identify an RT, globally unique in the network required: true style: simple schema: type: string - name: route-target-role in: path description: Role assigned to this route target required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets: get: tags: - Network summary: getNetworkVpnBindingsVpnBindingRouteTargets description: returns route-targets operationId: getNetworkVpnBindingsVpnBindingRouteTargets parameters: - name: vpn-id in: path description: VPN ID, globally unique within A&AI required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/route-targets1' - description: Collection of route target information default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkVpnBindingsVpnBindingRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkVpnBindingsVpnBindingRelationshipListRelationship parameters: - name: vpn-id in: path description: VPN ID, globally unique within A&AI required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVpnBindingsVpnBinding.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVpnBindingsVpnBinding.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVpnBindingsVpnBindingRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkVpnBindingsVpnBindingRelationshipListRelationship parameters: - name: vpn-id in: path description: VPN ID, globally unique within A&AI required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vpn-bindings/vpn-binding/{vpn-id}: get: tags: - Network summary: getNetworkVpnBindingsVpnBinding description: returns vpn-binding operationId: getNetworkVpnBindingsVpnBinding parameters: - name: vpn-id in: path description: VPN ID, globally unique within A&AI required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/vpn-binding1' - description: >- VPN binding ###### Related Nodes - 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 - FROM vrf( vrf AppliesTo vpn-binding, MANY2ONE) A vrf uses a vpn-binding. -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also -(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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkVpnBindingsVpnBinding description: > Create or update an existing vpn-binding. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkVpnBindingsVpnBinding parameters: - name: vpn-id in: path description: VPN ID, globally unique within A&AI required: true style: simple schema: type: string requestBody: description: vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVpnBindingsVpnBinding.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/vpn-binding' - description: vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVpnBindingsVpnBinding.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkVpnBindingsVpnBinding description: > Update an existing vpn-binding # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkVpnBindingsVpnBinding parameters: - name: vpn-id in: path description: VPN ID, globally unique within A&AI required: true style: simple schema: type: string requestBody: description: vpn-binding object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/vpn-binding2' - description: vpn-binding object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVpnBindingsVpnBinding description: delete an existing vpn-binding operationId: deleteNetworkVpnBindingsVpnBinding parameters: - name: vpn-id in: path description: VPN ID, globally unique within A&AI required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vpn-bindings: get: tags: - Network summary: getNetworkVpnBindings description: returns vpn-bindings operationId: getNetworkVpnBindings parameters: - name: vpn-id in: query description: '' style: form explode: true schema: type: string - name: vpn-name in: query description: '' style: form explode: true schema: type: string - name: vpn-type in: query description: '' style: form explode: true schema: type: string - name: access-provider-id in: query description: '' style: form explode: true schema: type: string - name: access-client-id in: query description: '' style: form explode: true schema: type: string - name: access-topology-id in: query description: '' style: form explode: true schema: type: string - name: src-access-node-id in: query description: '' style: form explode: true schema: type: string - name: src-access-ltp-id in: query description: '' style: form explode: true schema: type: string - name: dst-access-node-id in: query description: '' style: form explode: true schema: type: string - name: dst-access-ltp-id in: query description: '' style: form explode: true schema: type: string - name: operational-status in: query description: '' style: form explode: true schema: type: string - name: model-invariant-id in: query description: '' style: form explode: true schema: type: string - name: model-version-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/vpn-bindings1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPeRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkVplsPesVplsPeRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPe.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPe.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPeRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkVplsPesVplsPeRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterface.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterface.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship : put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pf-pci-id in: path description: Identifier for the sriov-pf required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pf-pci-id in: path description: Identifier for the sriov-pf required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}: get: tags: - Network summary: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf description: returns sriov-pf operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pf-pci-id in: path description: Identifier for the sriov-pf required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-pf1' - description: >- SR-IOV Physical Function ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf description: > Create or update an existing sriov-pf. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pf-pci-id in: path description: Identifier for the sriov-pf required: true style: simple schema: type: string requestBody: description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-pf' - description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf description: > Update an existing sriov-pf # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pf-pci-id in: path description: Identifier for the sriov-pf required: true style: simple schema: type: string requestBody: description: sriov-pf object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-pf2' - description: sriov-pf object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf description: delete an existing sriov-pf operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pf-pci-id in: path description: Identifier for the sriov-pf required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs: get: tags: - Network summary: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfs description: returns sriov-pfs operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfs parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pf-pci-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-pfs1' - description: Collection of SR-IOV Physical Functions. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - Network summary: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: returns l3-interface-ipv4-address-list operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list1' - description: >- IPv4 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: > Create or update an existing l3-interface-ipv4-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list' - description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: > Update an existing l3-interface-ipv4-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list2' - description: l3-interface-ipv4-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: delete an existing l3-interface-ipv4-address-list operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - Network summary: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: returns l3-interface-ipv6-address-list operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list1' - description: >- IPv6 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: > Create or update an existing l3-interface-ipv6-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list' - description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: > Update an existing l3-interface-ipv6-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list2' - description: l3-interface-ipv6-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: delete an existing l3-interface-ipv6-address-list operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface} : get: tags: - Network summary: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan description: returns vlan operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan1' - description: >- Definition of vlan ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan description: > Create or update an existing vlan. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string requestBody: description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan' - description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan description: > Update an existing vlan # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string requestBody: description: vlan object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan2' - description: vlan object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan description: delete an existing vlan operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans : get: tags: - Network summary: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlans description: returns vlans operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlans parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: query description: '' style: form explode: true schema: type: string - name: vlan-id-inner in: query description: '' style: form explode: true schema: type: integer format: int64 - name: vpn-key in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/vlans1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - Network summary: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf description: returns sriov-vf operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vf1' - description: >- SR-IOV Virtual Function (not to be confused with virtual network function) ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf description: > Create or update an existing sriov-vf. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string requestBody: description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vf' - description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf description: > Update an existing sriov-vf # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string requestBody: description: sriov-vf object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vf2' - description: sriov-vf object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf description: delete an existing sriov-vf operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs : get: tags: - Network summary: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfs description: returns sriov-vfs operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfs parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pci-id in: query description: '' style: form explode: true schema: type: string - name: vf-vlan-filter in: query description: '' style: form explode: true schema: type: string - name: vf-mac-filter in: query description: '' style: form explode: true schema: type: string - name: vf-vlan-strip in: query description: '' style: form explode: true schema: type: boolean - name: neutron-network-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vfs1' - description: Collection of SR-IOV Virtual Functions. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship : put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - Network summary: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList description: returns l3-interface-ipv4-address-list operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list1' - description: >- IPv4 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList description: > Create or update an existing l3-interface-ipv4-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list' - description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList description: > Update an existing l3-interface-ipv4-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list2' - description: l3-interface-ipv4-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList description: delete an existing l3-interface-ipv4-address-list operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - Network summary: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList description: returns l3-interface-ipv6-address-list operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list1' - description: >- IPv6 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList description: > Create or update an existing l3-interface-ipv6-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list' - description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList description: > Update an existing l3-interface-ipv6-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list2' - description: l3-interface-ipv6-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList description: delete an existing l3-interface-ipv6-address-list operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}: get: tags: - Network summary: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface description: returns l-interface operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interface1' - description: >- Logical interfaces, e.g., a vnic. ###### Related Nodes - 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 vrf( vrf Uses l-interface, ONE2MANY) - FROM l3-interface-ipv4-address-list (CHILD of l-interface, l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1) - FROM l3-interface-ipv6-address-list (CHILD of l-interface, l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1) - FROM lag-interface( lag-interface Uses l-interface, 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface description: > Create or update an existing l-interface. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string requestBody: description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interface' - description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface description: > Update an existing l-interface # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string requestBody: description: l-interface object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interface2' - description: l-interface object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface description: delete an existing l-interface operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces: get: tags: - Network summary: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfaces description: returns l-interfaces operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfaces parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: interface-id in: query description: '' style: form explode: true schema: type: string - name: macaddr in: query description: '' style: form explode: true schema: type: string - name: network-name in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interfaces1' - description: Collection of logical interfaces. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}: get: tags: - Network summary: getNetworkVplsPesVplsPePInterfacesPInterface description: returns p-interface operationId: getNetworkVplsPesVplsPePInterfacesPInterface parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/p-interface1' - description: >- Physical interface (e.g., nic) ###### Related Nodes - 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 allotted-resource( allotted-resource Uses p-interface, ONE2MANY) AAI-1925 For CCVPN Usecase - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterface description: > Create or update an existing p-interface. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterface parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string requestBody: description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterface.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/p-interface' - description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPePInterfacesPInterface.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkVplsPesVplsPePInterfacesPInterface description: > Update an existing p-interface # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterface parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string requestBody: description: p-interface object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/p-interface2' - description: p-interface object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPePInterfacesPInterface description: delete an existing p-interface operationId: deleteNetworkVplsPesVplsPePInterfacesPInterface parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces: get: tags: - Network summary: getNetworkVplsPesVplsPePInterfaces description: returns p-interfaces operationId: getNetworkVplsPesVplsPePInterfaces parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: query description: '' style: form explode: true schema: type: string - name: prov-status in: query description: '' style: form explode: true schema: type: string - name: operational-status in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/p-interfaces1' - description: Collection of physical interfaces. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterface.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterface.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - Network summary: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: returns l3-interface-ipv4-address-list operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list1' - description: >- IPv4 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: > Create or update an existing l3-interface-ipv4-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list' - description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: > Update an existing l3-interface-ipv4-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list2' - description: l3-interface-ipv4-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: delete an existing l3-interface-ipv4-address-list operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - Network summary: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: returns l3-interface-ipv6-address-list operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list1' - description: >- IPv6 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: > Create or update an existing l3-interface-ipv6-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list' - description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: > Update an existing l3-interface-ipv6-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list2' - description: l3-interface-ipv6-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: delete an existing l3-interface-ipv6-address-list operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface} : get: tags: - Network summary: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan description: returns vlan operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan1' - description: >- Definition of vlan ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan description: > Create or update an existing vlan. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string requestBody: description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan' - description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan description: > Update an existing vlan # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string requestBody: description: vlan object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan2' - description: vlan object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan description: delete an existing vlan operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans : get: tags: - Network summary: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans description: returns vlans operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: query description: '' style: form explode: true schema: type: string - name: vlan-id-inner in: query description: '' style: form explode: true schema: type: integer format: int64 - name: vpn-key in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/vlans1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - Network summary: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf description: returns sriov-vf operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vf1' - description: >- SR-IOV Virtual Function (not to be confused with virtual network function) ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf description: > Create or update an existing sriov-vf. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string requestBody: description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vf' - description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf description: > Update an existing sriov-vf # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string requestBody: description: sriov-vf object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vf2' - description: sriov-vf object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf description: delete an existing sriov-vf operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs : get: tags: - Network summary: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs description: returns sriov-vfs operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: pci-id in: query description: '' style: form explode: true schema: type: string - name: vf-vlan-filter in: query description: '' style: form explode: true schema: type: string - name: vf-mac-filter in: query description: '' style: form explode: true schema: type: string - name: vf-vlan-strip in: query description: '' style: form explode: true schema: type: boolean - name: neutron-network-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vfs1' - description: Collection of SR-IOV Virtual Functions. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship : put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - Network summary: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList description: returns l3-interface-ipv4-address-list operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list1' - description: >- IPv4 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList description: > Create or update an existing l3-interface-ipv4-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list' - description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList description: > Update an existing l3-interface-ipv4-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list2' - description: l3-interface-ipv4-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList description: delete an existing l3-interface-ipv4-address-list operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - Network summary: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList description: returns l3-interface-ipv6-address-list operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list1' - description: >- IPv6 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList description: > Create or update an existing l3-interface-ipv6-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list' - description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList description: > Update an existing l3-interface-ipv6-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list2' - description: l3-interface-ipv6-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList description: delete an existing l3-interface-ipv6-address-list operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name} : get: tags: - Network summary: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface description: returns l-interface operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interface1' - description: >- Logical interfaces, e.g., a vnic. ###### Related Nodes - 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 vrf( vrf Uses l-interface, ONE2MANY) - FROM l3-interface-ipv4-address-list (CHILD of l-interface, l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1) - FROM l3-interface-ipv6-address-list (CHILD of l-interface, l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1) - FROM lag-interface( lag-interface Uses l-interface, 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface description: > Create or update an existing l-interface. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string requestBody: description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interface' - description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface description: > Update an existing l-interface # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string requestBody: description: l-interface object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interface2' - description: l-interface object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface description: delete an existing l-interface operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces: get: tags: - Network summary: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfaces description: returns l-interfaces operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfaces parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: interface-id in: query description: '' style: form explode: true schema: type: string - name: macaddr in: query description: '' style: form explode: true schema: type: string - name: network-name in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interfaces1' - description: Collection of logical interfaces. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}: get: tags: - Network summary: getNetworkVplsPesVplsPeLagInterfacesLagInterface description: returns lag-interface operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterface parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/lag-interface1' - description: >- Link aggregate interface ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterface description: > Create or update an existing lag-interface. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterface parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string requestBody: description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterface.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/lag-interface' - description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPeLagInterfacesLagInterface.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterface description: > Update an existing lag-interface # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterface parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string requestBody: description: lag-interface object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/lag-interface2' - description: lag-interface object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPeLagInterfacesLagInterface description: delete an existing lag-interface operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterface parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces: get: tags: - Network summary: getNetworkVplsPesVplsPeLagInterfaces description: returns lag-interfaces operationId: getNetworkVplsPesVplsPeLagInterfaces parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: interface-name in: query description: '' style: form explode: true schema: type: string - name: interface-id in: query description: '' style: form explode: true schema: type: string - name: interface-role in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/lag-interfaces1' - description: Collection of link aggregate interfaces. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vpls-pes/vpls-pe/{equipment-name}: get: tags: - Network summary: getNetworkVplsPesVplsPe description: returns vpls-pe operationId: getNetworkVplsPesVplsPe parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/vpls-pe1' - description: >- VPLS Provider Edge routers. ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkVplsPesVplsPe description: > Create or update an existing vpls-pe. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkVplsPesVplsPe parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string requestBody: description: vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPe.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/vpls-pe' - description: vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVplsPesVplsPe.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkVplsPesVplsPe description: > Update an existing vpls-pe # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkVplsPesVplsPe parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string requestBody: description: vpls-pe object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/vpls-pe2' - description: vpls-pe object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVplsPesVplsPe description: delete an existing vpls-pe operationId: deleteNetworkVplsPesVplsPe parameters: - name: equipment-name in: path description: '' required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vpls-pes: get: tags: - Network summary: getNetworkVplsPes description: returns vpls-pes operationId: getNetworkVplsPes parameters: - name: equipment-name in: query description: '' style: form explode: true schema: type: string - name: prov-status in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/vpls-pes1' - description: Collection of VPLS Provider Edge routers default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship parameters: - name: multicast-configuration-id in: path description: Unique id of multicast configuration. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkMulticastConfigurationsMulticastConfiguration.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkMulticastConfigurationsMulticastConfiguration.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship parameters: - name: multicast-configuration-id in: path description: Unique id of multicast configuration. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}: get: tags: - Network summary: getNetworkMulticastConfigurationsMulticastConfiguration description: returns multicast-configuration operationId: getNetworkMulticastConfigurationsMulticastConfiguration parameters: - name: multicast-configuration-id in: path description: Unique id of multicast configuration. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/multicast-configuration1' - description: >- ###### Related Nodes - FROM vlan( vlan Uses multicast-configuration, MANY2MANY) default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkMulticastConfigurationsMulticastConfiguration description: > Create or update an existing multicast-configuration. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfiguration parameters: - name: multicast-configuration-id in: path description: Unique id of multicast configuration. required: true style: simple schema: type: string requestBody: description: multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkMulticastConfigurationsMulticastConfiguration.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/multicast-configuration' - description: multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkMulticastConfigurationsMulticastConfiguration.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkMulticastConfigurationsMulticastConfiguration description: > Update an existing multicast-configuration # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkMulticastConfigurationsMulticastConfiguration parameters: - name: multicast-configuration-id in: path description: Unique id of multicast configuration. required: true style: simple schema: type: string requestBody: description: multicast-configuration object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/multicast-configuration2' - description: multicast-configuration object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkMulticastConfigurationsMulticastConfiguration description: delete an existing multicast-configuration operationId: deleteNetworkMulticastConfigurationsMulticastConfiguration parameters: - name: multicast-configuration-id in: path description: Unique id of multicast configuration. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/multicast-configurations: get: tags: - Network summary: getNetworkMulticastConfigurations description: returns multicast-configurations operationId: getNetworkMulticastConfigurations parameters: - name: multicast-configuration-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/multicast-configurations1' - description: multicast configuration of generic-vnf ip-address default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship : put: tags: - Network summary: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-id in: path description: Unique ID of the interface required: true style: simple schema: type: string - name: cvlan-tag in: path description: See mis-na-virtualization-platform.yang required: true style: simple schema: type: integer format: int64 requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-id in: path description: Unique ID of the interface required: true style: simple schema: type: string - name: cvlan-tag in: path description: See mis-na-virtualization-platform.yang required: true style: simple schema: type: integer format: int64 responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}: get: tags: - Network summary: getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry description: returns cvlan-tag-entry operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-id in: path description: Unique ID of the interface required: true style: simple schema: type: string - name: cvlan-tag in: path description: See mis-na-virtualization-platform.yang required: true style: simple schema: type: integer format: int64 responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/cvlan-tag-entry1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry description: > Create or update an existing cvlan-tag-entry. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-id in: path description: Unique ID of the interface required: true style: simple schema: type: string - name: cvlan-tag in: path description: See mis-na-virtualization-platform.yang required: true style: simple schema: type: integer format: int64 requestBody: description: cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/cvlan-tag-entry' - description: cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry description: > Update an existing cvlan-tag-entry # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-id in: path description: Unique ID of the interface required: true style: simple schema: type: string - name: cvlan-tag in: path description: See mis-na-virtualization-platform.yang required: true style: simple schema: type: integer format: int64 requestBody: description: cvlan-tag-entry object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/cvlan-tag-entry2' - description: cvlan-tag-entry object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry description: delete an existing cvlan-tag-entry operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-id in: path description: Unique ID of the interface required: true style: simple schema: type: string - name: cvlan-tag in: path description: See mis-na-virtualization-platform.yang required: true style: simple schema: type: integer format: int64 - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags: get: tags: - Network summary: getNetworkVcesVcePortGroupsPortGroupCvlanTags description: returns cvlan-tags operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTags parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-id in: path description: Unique ID of the interface required: true style: simple schema: type: string - name: cvlan-tag in: query description: '' style: form explode: true schema: type: integer format: int64 responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/cvlan-tags1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-id in: path description: Unique ID of the interface required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVcesVcePortGroupsPortGroup.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVcesVcePortGroupsPortGroup.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-id in: path description: Unique ID of the interface required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}: get: tags: - Network summary: getNetworkVcesVcePortGroupsPortGroup description: returns port-group operationId: getNetworkVcesVcePortGroupsPortGroup parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-id in: path description: Unique ID of the interface required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/port-group1' - description: >- Used to capture the network interfaces of this VCE ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkVcesVcePortGroupsPortGroup description: > Create or update an existing port-group. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroup parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-id in: path description: Unique ID of the interface required: true style: simple schema: type: string requestBody: description: port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVcesVcePortGroupsPortGroup.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/port-group' - description: port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVcesVcePortGroupsPortGroup.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkVcesVcePortGroupsPortGroup description: > Update an existing port-group # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkVcesVcePortGroupsPortGroup parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-id in: path description: Unique ID of the interface required: true style: simple schema: type: string requestBody: description: port-group object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/port-group2' - description: port-group object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVcesVcePortGroupsPortGroup description: delete an existing port-group operationId: deleteNetworkVcesVcePortGroupsPortGroup parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-id in: path description: Unique ID of the interface required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vces/vce/{vnf-id}/port-groups: get: tags: - Network summary: getNetworkVcesVcePortGroups description: returns port-groups operationId: getNetworkVcesVcePortGroups parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-id in: query description: '' style: form explode: true schema: type: string - name: port-group-id in: query description: '' style: form explode: true schema: type: string - name: switch-name in: query description: '' style: form explode: true schema: type: string - name: heat-stack-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/port-groups1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkVcesVceLicensesLicenseRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkVcesVceLicensesLicenseRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: group-uuid in: path description: Unique ID for the license group the resource belongs to, should be uuid. required: true style: simple schema: type: string - name: resource-uuid in: path description: Unique ID of a license resource. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVcesVceLicensesLicense.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVcesVceLicensesLicense.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVcesVceLicensesLicenseRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkVcesVceLicensesLicenseRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: group-uuid in: path description: Unique ID for the license group the resource belongs to, should be uuid. required: true style: simple schema: type: string - name: resource-uuid in: path description: Unique ID of a license resource. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}: get: tags: - Network summary: getNetworkVcesVceLicensesLicense description: returns license operationId: getNetworkVcesVceLicensesLicense parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: group-uuid in: path description: Unique ID for the license group the resource belongs to, should be uuid. required: true style: simple schema: type: string - name: resource-uuid in: path description: Unique ID of a license resource. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/license1' - description: >- Metadata for license group. ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkVcesVceLicensesLicense description: > Create or update an existing license. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkVcesVceLicensesLicense parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: group-uuid in: path description: Unique ID for the license group the resource belongs to, should be uuid. required: true style: simple schema: type: string - name: resource-uuid in: path description: Unique ID of a license resource. required: true style: simple schema: type: string requestBody: description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVcesVceLicensesLicense.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/license' - description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVcesVceLicensesLicense.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkVcesVceLicensesLicense description: > Update an existing license # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkVcesVceLicensesLicense parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: group-uuid in: path description: Unique ID for the license group the resource belongs to, should be uuid. required: true style: simple schema: type: string - name: resource-uuid in: path description: Unique ID of a license resource. required: true style: simple schema: type: string requestBody: description: license object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/license2' - description: license object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVcesVceLicensesLicense description: delete an existing license operationId: deleteNetworkVcesVceLicensesLicense parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: group-uuid in: path description: Unique ID for the license group the resource belongs to, should be uuid. required: true style: simple schema: type: string - name: resource-uuid in: path description: Unique ID of a license resource. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vces/vce/{vnf-id}/licenses: get: tags: - Network summary: getNetworkVcesVceLicenses description: returns licenses operationId: getNetworkVcesVceLicenses parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: group-uuid in: query description: '' style: form explode: true schema: type: string - name: resource-uuid in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/licenses1' - description: Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: group-uuid in: path description: Unique ID for the entitlement group the resource comes from, should be uuid. required: true style: simple schema: type: string - name: resource-uuid in: path description: Unique ID of an entitlement resource. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVcesVceEntitlementsEntitlement.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVcesVceEntitlementsEntitlement.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: group-uuid in: path description: Unique ID for the entitlement group the resource comes from, should be uuid. required: true style: simple schema: type: string - name: resource-uuid in: path description: Unique ID of an entitlement resource. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}: get: tags: - Network summary: getNetworkVcesVceEntitlementsEntitlement description: returns entitlement operationId: getNetworkVcesVceEntitlementsEntitlement parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: group-uuid in: path description: Unique ID for the entitlement group the resource comes from, should be uuid. required: true style: simple schema: type: string - name: resource-uuid in: path description: Unique ID of an entitlement resource. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/entitlement1' - description: >- Metadata for entitlement group. ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkVcesVceEntitlementsEntitlement description: > Create or update an existing entitlement. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlement parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: group-uuid in: path description: Unique ID for the entitlement group the resource comes from, should be uuid. required: true style: simple schema: type: string - name: resource-uuid in: path description: Unique ID of an entitlement resource. required: true style: simple schema: type: string requestBody: description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVcesVceEntitlementsEntitlement.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/entitlement' - description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVcesVceEntitlementsEntitlement.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkVcesVceEntitlementsEntitlement description: > Update an existing entitlement # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkVcesVceEntitlementsEntitlement parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: group-uuid in: path description: Unique ID for the entitlement group the resource comes from, should be uuid. required: true style: simple schema: type: string - name: resource-uuid in: path description: Unique ID of an entitlement resource. required: true style: simple schema: type: string requestBody: description: entitlement object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/entitlement2' - description: entitlement object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVcesVceEntitlementsEntitlement description: delete an existing entitlement operationId: deleteNetworkVcesVceEntitlementsEntitlement parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: group-uuid in: path description: Unique ID for the entitlement group the resource comes from, should be uuid. required: true style: simple schema: type: string - name: resource-uuid in: path description: Unique ID of an entitlement resource. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vces/vce/{vnf-id}/entitlements: get: tags: - Network summary: getNetworkVcesVceEntitlements description: returns entitlements operationId: getNetworkVcesVceEntitlements parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: group-uuid in: query description: '' style: form explode: true schema: type: string - name: resource-uuid in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/entitlements1' - description: Entitlements, keyed by group-uuid and resource-uuid, related to license management default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vces/vce/{vnf-id}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkVcesVceRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkVcesVceRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVcesVce.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVcesVce.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVcesVceRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkVcesVceRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vces/vce/{vnf-id}: get: tags: - Network summary: getNetworkVcesVce description: returns vce operationId: getNetworkVcesVce parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/vce1' - description: >- Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated. ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkVcesVce description: > Create or update an existing vce. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkVcesVce parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string requestBody: description: vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVcesVce.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/vce' - description: vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVcesVce.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkVcesVce description: > Update an existing vce # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkVcesVce parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string requestBody: description: vce object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/vce2' - description: vce object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVcesVce description: delete an existing vce operationId: deleteNetworkVcesVce parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vces: get: tags: - Network summary: getNetworkVces description: returns vces operationId: getNetworkVces parameters: - name: vnf-id in: query description: '' style: form explode: true schema: type: string - name: vnf-name in: query description: '' style: form explode: true schema: type: string - name: vnf-name2 in: query description: '' style: form explode: true schema: type: string - name: vnf-type in: query description: '' style: form explode: true schema: type: string - name: service-id in: query description: '' style: form explode: true schema: type: string - name: regional-resource-zone in: query description: '' style: form explode: true schema: type: string - name: prov-status in: query description: '' style: form explode: true schema: type: string - name: heat-stack-id in: query description: '' style: form explode: true schema: type: string - name: vpe-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/vces1' - description: Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfc.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfc.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVnfcsVnfcRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkVnfcsVnfcRelationshipListRelationship parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkVnfcsVnfcCpsCpRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkVnfcsVnfcCpsCpRelationshipListRelationship parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string - name: cp-instance-id in: path description: Unique ID of the connection point. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfcCpsCp.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfcCpsCp.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVnfcsVnfcCpsCpRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkVnfcsVnfcCpsCpRelationshipListRelationship parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string - name: cp-instance-id in: path description: Unique ID of the connection point. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship : put: tags: - Network summary: createOrUpdateNetworkVnfcsVnfcCpsCpL3InterfaceIpv4AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkVnfcsVnfcCpsCpL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string - name: cp-instance-id in: path description: Unique ID of the connection point. required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfcCpsCpL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfcCpsCpL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVnfcsVnfcCpsCpL3InterfaceIpv4AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkVnfcsVnfcCpsCpL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string - name: cp-instance-id in: path description: Unique ID of the connection point. required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: get: tags: - Network summary: getNetworkVnfcsVnfcCpsCpL3InterfaceIpv4AddressList description: returns l3-interface-ipv4-address-list operationId: getNetworkVnfcsVnfcCpsCpL3InterfaceIpv4AddressList parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string - name: cp-instance-id in: path description: Unique ID of the connection point. required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list1' - description: >- IPv4 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkVnfcsVnfcCpsCpL3InterfaceIpv4AddressList description: > Create or update an existing l3-interface-ipv4-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkVnfcsVnfcCpsCpL3InterfaceIpv4AddressList parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string - name: cp-instance-id in: path description: Unique ID of the connection point. required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfcCpsCpL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list' - description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfcCpsCpL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkVnfcsVnfcCpsCpL3InterfaceIpv4AddressList description: > Update an existing l3-interface-ipv4-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkVnfcsVnfcCpsCpL3InterfaceIpv4AddressList parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string - name: cp-instance-id in: path description: Unique ID of the connection point. required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list2' - description: l3-interface-ipv4-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVnfcsVnfcCpsCpL3InterfaceIpv4AddressList description: delete an existing l3-interface-ipv4-address-list operationId: deleteNetworkVnfcsVnfcCpsCpL3InterfaceIpv4AddressList parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string - name: cp-instance-id in: path description: Unique ID of the connection point. required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship : put: tags: - Network summary: createOrUpdateNetworkVnfcsVnfcCpsCpL3InterfaceIpv6AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkVnfcsVnfcCpsCpL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string - name: cp-instance-id in: path description: Unique ID of the connection point. required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfcCpsCpL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfcCpsCpL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVnfcsVnfcCpsCpL3InterfaceIpv6AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkVnfcsVnfcCpsCpL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string - name: cp-instance-id in: path description: Unique ID of the connection point. required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: get: tags: - Network summary: getNetworkVnfcsVnfcCpsCpL3InterfaceIpv6AddressList description: returns l3-interface-ipv6-address-list operationId: getNetworkVnfcsVnfcCpsCpL3InterfaceIpv6AddressList parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string - name: cp-instance-id in: path description: Unique ID of the connection point. required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list1' - description: >- IPv6 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkVnfcsVnfcCpsCpL3InterfaceIpv6AddressList description: > Create or update an existing l3-interface-ipv6-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkVnfcsVnfcCpsCpL3InterfaceIpv6AddressList parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string - name: cp-instance-id in: path description: Unique ID of the connection point. required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfcCpsCpL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list' - description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfcCpsCpL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkVnfcsVnfcCpsCpL3InterfaceIpv6AddressList description: > Update an existing l3-interface-ipv6-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkVnfcsVnfcCpsCpL3InterfaceIpv6AddressList parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string - name: cp-instance-id in: path description: Unique ID of the connection point. required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list2' - description: l3-interface-ipv6-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVnfcsVnfcCpsCpL3InterfaceIpv6AddressList description: delete an existing l3-interface-ipv6-address-list operationId: deleteNetworkVnfcsVnfcCpsCpL3InterfaceIpv6AddressList parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string - name: cp-instance-id in: path description: Unique ID of the connection point. required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vnfcs/vnfc/{vnfc-name}/cps/cp/{cp-instance-id}: get: tags: - Network summary: getNetworkVnfcsVnfcCpsCp description: returns cp operationId: getNetworkVnfcsVnfcCpsCp parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string - name: cp-instance-id in: path description: Unique ID of the connection point. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/cp1' - description: >- point of attachment from services or resources to a virtual link or network. ###### Related Nodes - FROM l-interface( l-interface LinksTo cp, ONE2ONE) - FROM l3-interface-ipv4-address-list (CHILD of cp, l3-interface-ipv4-address-list BelongsTo cp, MANY2ONE)(1) - FROM l3-interface-ipv6-address-list (CHILD of cp, l3-interface-ipv6-address-list BelongsTo cp, MANY2ONE)(1) - FROM l3-network( l3-network LinksTo cp, MANY2MANY) - FROM metadatum( metadatum AppliesTo cp, MANY2MANY) AAI-2154 For BBS Usecase - FROM vip-ipv4-address-list( vip-ipv4-address-list Uses cp, MANY2MANY) - FROM vip-ipv6-address-list( vip-ipv6-address-list Uses cp, MANY2MANY) - FROM vlan-tag( vlan-tag Uses cp, MANY2MANY) - FROM vnfc (PARENT of cp, vnfc BelongsTo cp, ONE2MANY) cp is child of vnfc(3) -(1) IF this CP node is deleted, this FROM node is DELETED also -(3) IF this FROM node is deleted, this CP is DELETED also default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkVnfcsVnfcCpsCp description: > Create or update an existing cp. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkVnfcsVnfcCpsCp parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string - name: cp-instance-id in: path description: Unique ID of the connection point. required: true style: simple schema: type: string requestBody: description: cp object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfcCpsCp.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/cp' - description: cp object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfcCpsCp.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkVnfcsVnfcCpsCp description: > Update an existing cp # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkVnfcsVnfcCpsCp parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string - name: cp-instance-id in: path description: Unique ID of the connection point. required: true style: simple schema: type: string requestBody: description: cp object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/cp2' - description: cp object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVnfcsVnfcCpsCp description: delete an existing cp operationId: deleteNetworkVnfcsVnfcCpsCp parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string - name: cp-instance-id in: path description: Unique ID of the connection point. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vnfcs/vnfc/{vnfc-name}/cps: get: tags: - Network summary: getNetworkVnfcsVnfcCps description: returns cps operationId: getNetworkVnfcsVnfcCps parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/cps1' - description: Collection of connection points. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}: get: tags: - Network summary: getNetworkVnfcsVnfcL3InterfaceIpv4AddressList description: returns l3-interface-ipv4-address-list operationId: getNetworkVnfcsVnfcL3InterfaceIpv4AddressList parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list1' - description: >- IPv4 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList description: > Create or update an existing l3-interface-ipv4-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list' - description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList description: > Update an existing l3-interface-ipv4-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list2' - description: l3-interface-ipv4-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressList description: delete an existing l3-interface-ipv4-address-list operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressList parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}: get: tags: - Network summary: getNetworkVnfcsVnfcL3InterfaceIpv6AddressList description: returns l3-interface-ipv6-address-list operationId: getNetworkVnfcsVnfcL3InterfaceIpv6AddressList parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list1' - description: >- IPv6 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList description: > Create or update an existing l3-interface-ipv6-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list' - description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList description: > Update an existing l3-interface-ipv6-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list2' - description: l3-interface-ipv6-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressList description: delete an existing l3-interface-ipv6-address-list operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressList parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vnfcs/vnfc/{vnfc-name}: get: tags: - Network summary: getNetworkVnfcsVnfc description: returns vnfc operationId: getNetworkVnfcsVnfc parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/vnfc1' - description: >- ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkVnfcsVnfc description: > Create or update an existing vnfc. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkVnfcsVnfc parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string requestBody: description: vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfc.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/vnfc' - description: vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVnfcsVnfc.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkVnfcsVnfc description: > Update an existing vnfc # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkVnfcsVnfc parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string requestBody: description: vnfc object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/vnfc2' - description: vnfc object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVnfcsVnfc description: delete an existing vnfc operationId: deleteNetworkVnfcsVnfc parameters: - name: vnfc-name in: path description: Unique ID of vnfc. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vnfcs: get: tags: - Network summary: getNetworkVnfcs description: returns vnfcs operationId: getNetworkVnfcs parameters: - name: vnfc-name in: query description: '' style: form explode: true schema: type: string - name: nfc-naming-code in: query description: '' style: form explode: true schema: type: string - name: nfc-function in: query description: '' style: form explode: true schema: type: string - name: prov-status in: query description: '' style: form explode: true schema: type: string - name: ipaddress-v4-oam-vip in: query description: '' style: form explode: true schema: type: string - name: in-maint in: query description: '' style: form explode: true schema: type: boolean - name: is-closed-loop-disabled in: query description: '' style: form explode: true schema: type: boolean - name: group-notation in: query description: '' style: form explode: true schema: type: string - name: model-invariant-id in: query description: '' style: form explode: true schema: type: string - name: model-version-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/vnfcs1' - description: virtual network components associated with a vserver from application controller. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship : put: tags: - Network summary: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string - name: subnet-id in: path description: Subnet ID, should be UUID. required: true style: simple schema: type: string - name: host-route-id in: path description: host-route id required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string - name: subnet-id in: path description: Subnet ID, should be UUID. required: true style: simple schema: type: string - name: host-route-id in: path description: host-route id required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}: get: tags: - Network summary: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute description: returns host-route operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string - name: subnet-id in: path description: Subnet ID, should be UUID. required: true style: simple schema: type: string - name: host-route-id in: path description: host-route id required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/host-route1' - description: >- ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute description: > Create or update an existing host-route. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string - name: subnet-id in: path description: Subnet ID, should be UUID. required: true style: simple schema: type: string - name: host-route-id in: path description: host-route id required: true style: simple schema: type: string requestBody: description: host-route object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/host-route' - description: host-route object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute description: > Update an existing host-route # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string - name: subnet-id in: path description: Subnet ID, should be UUID. required: true style: simple schema: type: string - name: host-route-id in: path description: host-route id required: true style: simple schema: type: string requestBody: description: host-route object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/host-route2' - description: host-route object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute description: delete an existing host-route operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string - name: subnet-id in: path description: Subnet ID, should be UUID. required: true style: simple schema: type: string - name: host-route-id in: path description: host-route id required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes: get: tags: - Network summary: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutes description: returns host-routes operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutes parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string - name: subnet-id in: path description: Subnet ID, should be UUID. required: true style: simple schema: type: string - name: host-route-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/host-routes1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string - name: subnet-id in: path description: Subnet ID, should be UUID. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3NetworkSubnetsSubnet.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3NetworkSubnetsSubnet.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string - name: subnet-id in: path description: Subnet ID, should be UUID. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}: get: tags: - Network summary: getNetworkL3NetworksL3NetworkSubnetsSubnet description: returns subnet operationId: getNetworkL3NetworksL3NetworkSubnetsSubnet parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string - name: subnet-id in: path description: Subnet ID, should be UUID. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/subnet1' - description: >- ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnet description: > Create or update an existing subnet. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnet parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string - name: subnet-id in: path description: Subnet ID, should be UUID. required: true style: simple schema: type: string requestBody: description: subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3NetworkSubnetsSubnet.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/subnet' - description: subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3NetworkSubnetsSubnet.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkL3NetworksL3NetworkSubnetsSubnet description: > Update an existing subnet # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnet parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string - name: subnet-id in: path description: Subnet ID, should be UUID. required: true style: simple schema: type: string requestBody: description: subnet object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/subnet2' - description: subnet object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkL3NetworksL3NetworkSubnetsSubnet description: delete an existing subnet operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnet parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string - name: subnet-id in: path description: Subnet ID, should be UUID. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/l3-networks/l3-network/{network-id}/subnets: get: tags: - Network summary: getNetworkL3NetworksL3NetworkSubnets description: returns subnets operationId: getNetworkL3NetworksL3NetworkSubnets parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string - name: subnet-id in: query description: '' style: form explode: true schema: type: string - name: subnet-name in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/subnets1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string - name: vlan-id-inner in: path description: id. required: true style: simple schema: type: integer format: int64 requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string - name: vlan-id-inner in: path description: id. required: true style: simple schema: type: integer format: int64 responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}: get: tags: - Network summary: getNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment description: returns ctag-assignment operationId: getNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string - name: vlan-id-inner in: path description: id. required: true style: simple schema: type: integer format: int64 responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/ctag-assignment1' - description: >- ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment description: > Create or update an existing ctag-assignment. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string - name: vlan-id-inner in: path description: id. required: true style: simple schema: type: integer format: int64 requestBody: description: ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/ctag-assignment' - description: ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment description: > Update an existing ctag-assignment # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string - name: vlan-id-inner in: path description: id. required: true style: simple schema: type: integer format: int64 requestBody: description: ctag-assignment object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/ctag-assignment2' - description: ctag-assignment object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment description: delete an existing ctag-assignment operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string - name: vlan-id-inner in: path description: id. required: true style: simple schema: type: integer format: int64 - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/l3-networks/l3-network/{network-id}/ctag-assignments: get: tags: - Network summary: getNetworkL3NetworksL3NetworkCtagAssignments description: returns ctag-assignments operationId: getNetworkL3NetworksL3NetworkCtagAssignments parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string - name: vlan-id-inner in: query description: '' style: form explode: true schema: type: integer format: int64 responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/ctag-assignments1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship : put: tags: - Network summary: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string - name: segmentation-id in: path description: Route Table Reference id, UUID assigned to this instance. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string - name: segmentation-id in: path description: Route Table Reference id, UUID assigned to this instance. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}: get: tags: - Network summary: getNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment description: returns segmentation-assignment operationId: getNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string - name: segmentation-id in: path description: Route Table Reference id, UUID assigned to this instance. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/segmentation-assignment1' - description: >- Openstack segmentation assignment. ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment description: > Create or update an existing segmentation-assignment. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string - name: segmentation-id in: path description: Route Table Reference id, UUID assigned to this instance. required: true style: simple schema: type: string requestBody: description: segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/segmentation-assignment' - description: segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment description: > Update an existing segmentation-assignment # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string - name: segmentation-id in: path description: Route Table Reference id, UUID assigned to this instance. required: true style: simple schema: type: string requestBody: description: segmentation-assignment object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/segmentation-assignment2' - description: segmentation-assignment object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment description: delete an existing segmentation-assignment operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string - name: segmentation-id in: path description: Route Table Reference id, UUID assigned to this instance. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/l3-networks/l3-network/{network-id}/segmentation-assignments: get: tags: - Network summary: getNetworkL3NetworksL3NetworkSegmentationAssignments description: returns segmentation-assignments operationId: getNetworkL3NetworksL3NetworkSegmentationAssignments parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string - name: segmentation-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/segmentation-assignments1' - description: Collection of openstack segmentation assignments default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/l3-networks/l3-network/{network-id}/aggregate-routes/aggregate-route/{route-id}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkL3NetworksL3NetworkAggregateRoutesAggregateRouteRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkL3NetworksL3NetworkAggregateRoutesAggregateRouteRelationshipListRelationship parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string - name: route-id in: path description: Unique id of the aggregate-route instance required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3NetworkAggregateRoutesAggregateRoute.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3NetworkAggregateRoutesAggregateRoute.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkL3NetworksL3NetworkAggregateRoutesAggregateRouteRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkL3NetworksL3NetworkAggregateRoutesAggregateRouteRelationshipListRelationship parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string - name: route-id in: path description: Unique id of the aggregate-route instance required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/l3-networks/l3-network/{network-id}/aggregate-routes/aggregate-route/{route-id}: get: tags: - Network summary: getNetworkL3NetworksL3NetworkAggregateRoutesAggregateRoute description: returns aggregate-route operationId: getNetworkL3NetworksL3NetworkAggregateRoutesAggregateRoute parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string - name: route-id in: path description: Unique id of the aggregate-route instance required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/aggregate-route1' - description: "Aggregate route configs are used on the D2 IPE’s for the Voice services. In 1902, SDNC will create aggregate-route objects and write them to A&AI. \n###### Related Nodes\n- TO l3-network (PARENT of aggregate-route, aggregate-route BelongsTo l3-network, MANY2ONE)(4)\n\n-(4) IF this TO node is deleted, this AGGREGATE-ROUTE is DELETED also" default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkL3NetworksL3NetworkAggregateRoutesAggregateRoute description: > Create or update an existing aggregate-route. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkL3NetworksL3NetworkAggregateRoutesAggregateRoute parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string - name: route-id in: path description: Unique id of the aggregate-route instance required: true style: simple schema: type: string requestBody: description: aggregate-route object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3NetworkAggregateRoutesAggregateRoute.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/aggregate-route' - description: aggregate-route object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3NetworkAggregateRoutesAggregateRoute.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkL3NetworksL3NetworkAggregateRoutesAggregateRoute description: > Update an existing aggregate-route # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkL3NetworksL3NetworkAggregateRoutesAggregateRoute parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string - name: route-id in: path description: Unique id of the aggregate-route instance required: true style: simple schema: type: string requestBody: description: aggregate-route object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/aggregate-route2' - description: aggregate-route object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkL3NetworksL3NetworkAggregateRoutesAggregateRoute description: delete an existing aggregate-route operationId: deleteNetworkL3NetworksL3NetworkAggregateRoutesAggregateRoute parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string - name: route-id in: path description: Unique id of the aggregate-route instance required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/l3-networks/l3-network/{network-id}/aggregate-routes: get: tags: - Network summary: getNetworkL3NetworksL3NetworkAggregateRoutes description: returns aggregate-routes operationId: getNetworkL3NetworksL3NetworkAggregateRoutes parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/aggregate-routes1' - description: Collection of aggregate routes. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/l3-networks/l3-network/{network-id}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkL3NetworksL3NetworkRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkL3NetworksL3NetworkRelationshipListRelationship parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3Network.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3Network.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkL3NetworksL3NetworkRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkL3NetworksL3NetworkRelationshipListRelationship parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/l3-networks/l3-network/{network-id}: get: tags: - Network summary: getNetworkL3NetworksL3Network description: returns l3-network operationId: getNetworkL3NetworksL3Network parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-network1' - description: >- Generic network definition ###### Related Nodes - 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 aggregate-route (CHILD of l3-network, aggregate-route BelongsTo l3-network, MANY2ONE)(1) - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY) - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY) - FROM complex( complex Uses l3-network, MANY2MANY) - FROM configuration( configuration PartOf l3-network, MANY2MANY) - FROM ctag-assignment (CHILD of l3-network, ctag-assignment BelongsTo l3-network, MANY2ONE)(1) - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY) - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY) - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY) - FROM l3-network( l3-network Uses l3-network, MANY2MANY) - 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) - FROM vrf( vrf Uses l3-network, ONE2MANY) A vrf uses many l3-networks -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkL3NetworksL3Network description: > Create or update an existing l3-network. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkL3NetworksL3Network parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string requestBody: description: l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3Network.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-network' - description: l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkL3NetworksL3Network.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkL3NetworksL3Network description: > Update an existing l3-network # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkL3NetworksL3Network parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string requestBody: description: l3-network object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-network2' - description: l3-network object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkL3NetworksL3Network description: delete an existing l3-network operationId: deleteNetworkL3NetworksL3Network parameters: - name: network-id in: path description: Network ID, should be uuid. Unique across A&AI. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/l3-networks: get: tags: - Network summary: getNetworkL3Networks description: returns l3-networks operationId: getNetworkL3Networks parameters: - name: network-id in: query description: '' style: form explode: true schema: type: string - name: network-name in: query description: '' style: form explode: true schema: type: string - name: network-role in: query description: '' style: form explode: true schema: type: string - name: service-id in: query description: '' style: form explode: true schema: type: string - name: heat-stack-id in: query description: '' style: form explode: true schema: type: string - name: contrail-network-fqdn in: query description: '' style: form explode: true schema: type: string - name: model-invariant-id in: query description: '' style: form explode: true schema: type: string - name: model-version-id in: query description: '' style: form explode: true schema: type: string - name: widget-model-id in: query description: '' style: form explode: true schema: type: string - name: widget-model-version in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/l3-networks1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship parameters: - name: network-policy-id in: path description: UUID representing unique key to this instance required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNetworkPoliciesNetworkPolicy.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNetworkPoliciesNetworkPolicy.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship parameters: - name: network-policy-id in: path description: UUID representing unique key to this instance required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/network-policies/network-policy/{network-policy-id}: get: tags: - Network summary: getNetworkNetworkPoliciesNetworkPolicy description: returns network-policy operationId: getNetworkNetworkPoliciesNetworkPolicy parameters: - name: network-policy-id in: path description: UUID representing unique key to this instance required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/network-policy1' - description: >- ###### Related Nodes - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE) - FROM l3-network( l3-network Uses network-policy, MANY2MANY) default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkNetworkPoliciesNetworkPolicy description: > Create or update an existing network-policy. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicy parameters: - name: network-policy-id in: path description: UUID representing unique key to this instance required: true style: simple schema: type: string requestBody: description: network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNetworkPoliciesNetworkPolicy.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/network-policy' - description: network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNetworkPoliciesNetworkPolicy.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkNetworkPoliciesNetworkPolicy description: > Update an existing network-policy # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkNetworkPoliciesNetworkPolicy parameters: - name: network-policy-id in: path description: UUID representing unique key to this instance required: true style: simple schema: type: string requestBody: description: network-policy object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/network-policy2' - description: network-policy object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkNetworkPoliciesNetworkPolicy description: delete an existing network-policy operationId: deleteNetworkNetworkPoliciesNetworkPolicy parameters: - name: network-policy-id in: path description: UUID representing unique key to this instance required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/network-policies: get: tags: - Network summary: getNetworkNetworkPolicies description: returns network-policies operationId: getNetworkNetworkPolicies parameters: - name: network-policy-id in: query description: '' style: form explode: true schema: type: string - name: network-policy-fqdn in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/network-policies1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkGenericVnfsGenericVnfRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnf.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnf.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkGenericVnfsGenericVnfRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship : put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - Network summary: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: returns l3-interface-ipv4-address-list operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list1' - description: >- IPv4 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: > Create or update an existing l3-interface-ipv4-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list' - description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: > Update an existing l3-interface-ipv4-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list2' - description: l3-interface-ipv4-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: delete an existing l3-interface-ipv4-address-list operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - Network summary: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: returns l3-interface-ipv6-address-list operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list1' - description: >- IPv6 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: > Create or update an existing l3-interface-ipv6-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list' - description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: > Update an existing l3-interface-ipv6-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list2' - description: l3-interface-ipv6-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: delete an existing l3-interface-ipv6-address-list operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: get: tags: - Network summary: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan description: returns vlan operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan1' - description: >- Definition of vlan ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan description: > Create or update an existing vlan. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string requestBody: description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan' - description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan description: > Update an existing vlan # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string requestBody: description: vlan object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan2' - description: vlan object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan description: delete an existing vlan operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans: get: tags: - Network summary: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlans description: returns vlans operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlans parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: query description: '' style: form explode: true schema: type: string - name: vlan-id-inner in: query description: '' style: form explode: true schema: type: integer format: int64 - name: vpn-key in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/vlans1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship : put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: get: tags: - Network summary: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf description: returns sriov-vf operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vf1' - description: >- SR-IOV Virtual Function (not to be confused with virtual network function) ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf description: > Create or update an existing sriov-vf. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string requestBody: description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vf' - description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf description: > Update an existing sriov-vf # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string requestBody: description: sriov-vf object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vf2' - description: sriov-vf object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf description: delete an existing sriov-vf operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs: get: tags: - Network summary: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfs description: returns sriov-vfs operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfs parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: pci-id in: query description: '' style: form explode: true schema: type: string - name: vf-vlan-filter in: query description: '' style: form explode: true schema: type: string - name: vf-mac-filter in: query description: '' style: form explode: true schema: type: string - name: vf-vlan-strip in: query description: '' style: form explode: true schema: type: boolean - name: neutron-network-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vfs1' - description: Collection of SR-IOV Virtual Functions. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address} : get: tags: - Network summary: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList description: returns l3-interface-ipv4-address-list operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list1' - description: >- IPv4 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList description: > Create or update an existing l3-interface-ipv4-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list' - description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList description: > Update an existing l3-interface-ipv4-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list2' - description: l3-interface-ipv4-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList description: delete an existing l3-interface-ipv4-address-list operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address} : get: tags: - Network summary: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList description: returns l3-interface-ipv6-address-list operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list1' - description: >- IPv6 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList description: > Create or update an existing l3-interface-ipv6-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list' - description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList description: > Update an existing l3-interface-ipv6-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list2' - description: l3-interface-ipv6-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList description: delete an existing l3-interface-ipv6-address-list operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}: get: tags: - Network summary: getNetworkGenericVnfsGenericVnfLInterfacesLInterface description: returns l-interface operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterface parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interface1' - description: >- Logical interfaces, e.g., a vnic. ###### Related Nodes - 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 vrf( vrf Uses l-interface, ONE2MANY) - FROM l3-interface-ipv4-address-list (CHILD of l-interface, l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1) - FROM l3-interface-ipv6-address-list (CHILD of l-interface, l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1) - FROM lag-interface( lag-interface Uses l-interface, 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface description: > Create or update an existing l-interface. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string requestBody: description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interface' - description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface description: > Update an existing l-interface # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string requestBody: description: l-interface object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interface2' - description: l-interface object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterface description: delete an existing l-interface operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterface parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces: get: tags: - Network summary: getNetworkGenericVnfsGenericVnfLInterfaces description: returns l-interfaces operationId: getNetworkGenericVnfsGenericVnfLInterfaces parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: query description: '' style: form explode: true schema: type: string - name: interface-id in: query description: '' style: form explode: true schema: type: string - name: macaddr in: query description: '' style: form explode: true schema: type: string - name: network-name in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interfaces1' - description: Collection of logical interfaces. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - Network summary: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: returns l3-interface-ipv4-address-list operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list1' - description: >- IPv4 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: > Create or update an existing l3-interface-ipv4-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list' - description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: > Update an existing l3-interface-ipv4-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list2' - description: l3-interface-ipv4-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: delete an existing l3-interface-ipv4-address-list operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - Network summary: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: returns l3-interface-ipv6-address-list operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list1' - description: >- IPv6 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: > Create or update an existing l3-interface-ipv6-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list' - description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: > Update an existing l3-interface-ipv6-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list2' - description: l3-interface-ipv6-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: delete an existing l3-interface-ipv6-address-list operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface} : get: tags: - Network summary: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan description: returns vlan operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan1' - description: >- Definition of vlan ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan description: > Create or update an existing vlan. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string requestBody: description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan' - description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan description: > Update an existing vlan # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string requestBody: description: vlan object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan2' - description: vlan object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan description: delete an existing vlan operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans : get: tags: - Network summary: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans description: returns vlans operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: query description: '' style: form explode: true schema: type: string - name: vlan-id-inner in: query description: '' style: form explode: true schema: type: integer format: int64 - name: vpn-key in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/vlans1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - Network summary: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf description: returns sriov-vf operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vf1' - description: >- SR-IOV Virtual Function (not to be confused with virtual network function) ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf description: > Create or update an existing sriov-vf. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string requestBody: description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vf' - description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf description: > Update an existing sriov-vf # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string requestBody: description: sriov-vf object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vf2' - description: sriov-vf object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf description: delete an existing sriov-vf operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs : get: tags: - Network summary: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs description: returns sriov-vfs operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: pci-id in: query description: '' style: form explode: true schema: type: string - name: vf-vlan-filter in: query description: '' style: form explode: true schema: type: string - name: vf-mac-filter in: query description: '' style: form explode: true schema: type: string - name: vf-vlan-strip in: query description: '' style: form explode: true schema: type: boolean - name: neutron-network-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vfs1' - description: Collection of SR-IOV Virtual Functions. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship : put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - Network summary: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList description: returns l3-interface-ipv4-address-list operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list1' - description: >- IPv4 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList description: > Create or update an existing l3-interface-ipv4-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list' - description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList description: > Update an existing l3-interface-ipv4-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list2' - description: l3-interface-ipv4-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList description: delete an existing l3-interface-ipv4-address-list operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - Network summary: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList description: returns l3-interface-ipv6-address-list operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list1' - description: >- IPv6 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList description: > Create or update an existing l3-interface-ipv6-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list' - description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList description: > Update an existing l3-interface-ipv6-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list2' - description: l3-interface-ipv6-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList description: delete an existing l3-interface-ipv6-address-list operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name} : get: tags: - Network summary: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface description: returns l-interface operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interface1' - description: >- Logical interfaces, e.g., a vnic. ###### Related Nodes - 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 vrf( vrf Uses l-interface, ONE2MANY) - FROM l3-interface-ipv4-address-list (CHILD of l-interface, l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1) - FROM l3-interface-ipv6-address-list (CHILD of l-interface, l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1) - FROM lag-interface( lag-interface Uses l-interface, 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface description: > Create or update an existing l-interface. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string requestBody: description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interface' - description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface description: > Update an existing l-interface # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string requestBody: description: l-interface object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interface2' - description: l-interface object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface description: delete an existing l-interface operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces: get: tags: - Network summary: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfaces description: returns l-interfaces operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfaces parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: interface-id in: query description: '' style: form explode: true schema: type: string - name: macaddr in: query description: '' style: form explode: true schema: type: string - name: network-name in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interfaces1' - description: Collection of logical interfaces. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}: get: tags: - Network summary: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterface description: returns lag-interface operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterface parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/lag-interface1' - description: >- Link aggregate interface ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface description: > Create or update an existing lag-interface. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string requestBody: description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/lag-interface' - description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface description: > Update an existing lag-interface # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string requestBody: description: lag-interface object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/lag-interface2' - description: lag-interface object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterface description: delete an existing lag-interface operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterface parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces: get: tags: - Network summary: getNetworkGenericVnfsGenericVnfLagInterfaces description: returns lag-interfaces operationId: getNetworkGenericVnfsGenericVnfLagInterfaces parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: interface-name in: query description: '' style: form explode: true schema: type: string - name: interface-id in: query description: '' style: form explode: true schema: type: string - name: interface-role in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/lag-interfaces1' - description: Collection of link aggregate interfaces. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: vf-module-id in: path description: Unique ID of vf-module. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfVfModulesVfModule.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfVfModulesVfModule.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: vf-module-id in: path description: Unique ID of vf-module. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}: get: tags: - Network summary: getNetworkGenericVnfsGenericVnfVfModulesVfModule description: returns vf-module operationId: getNetworkGenericVnfsGenericVnfVfModulesVfModule parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: vf-module-id in: path description: Unique ID of vf-module. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/vf-module1' - description: >- a deployment unit of VNFCs ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModule description: > Create or update an existing vf-module. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModule parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: vf-module-id in: path description: Unique ID of vf-module. required: true style: simple schema: type: string requestBody: description: vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfVfModulesVfModule.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/vf-module' - description: vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfVfModulesVfModule.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkGenericVnfsGenericVnfVfModulesVfModule description: > Update an existing vf-module # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkGenericVnfsGenericVnfVfModulesVfModule parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: vf-module-id in: path description: Unique ID of vf-module. required: true style: simple schema: type: string requestBody: description: vf-module object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/vf-module2' - description: vf-module object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfVfModulesVfModule description: delete an existing vf-module operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModule parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: vf-module-id in: path description: Unique ID of vf-module. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules: get: tags: - Network summary: getNetworkGenericVnfsGenericVnfVfModules description: returns vf-modules operationId: getNetworkGenericVnfsGenericVnfVfModules parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: vf-module-id in: query description: '' style: form explode: true schema: type: string - name: vf-module-name in: query description: '' style: form explode: true schema: type: string - name: heat-stack-id in: query description: '' style: form explode: true schema: type: string - name: model-invariant-id in: query description: '' style: form explode: true schema: type: string - name: model-version-id in: query description: '' style: form explode: true schema: type: string - name: widget-model-id in: query description: '' style: form explode: true schema: type: string - name: widget-model-version in: query description: '' style: form explode: true schema: type: string - name: contrail-service-instance-fqdn in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/vf-modules1' - description: Collection of vf-modules, a deployment unit of VNFCs default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: group-uuid in: path description: Unique ID for the license group the resource belongs to, should be uuid. required: true style: simple schema: type: string - name: resource-uuid in: path description: Unique ID of a license resource. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLicensesLicense.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLicensesLicense.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: group-uuid in: path description: Unique ID for the license group the resource belongs to, should be uuid. required: true style: simple schema: type: string - name: resource-uuid in: path description: Unique ID of a license resource. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}: get: tags: - Network summary: getNetworkGenericVnfsGenericVnfLicensesLicense description: returns license operationId: getNetworkGenericVnfsGenericVnfLicensesLicense parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: group-uuid in: path description: Unique ID for the license group the resource belongs to, should be uuid. required: true style: simple schema: type: string - name: resource-uuid in: path description: Unique ID of a license resource. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/license1' - description: >- Metadata for license group. ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicense description: > Create or update an existing license. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicense parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: group-uuid in: path description: Unique ID for the license group the resource belongs to, should be uuid. required: true style: simple schema: type: string - name: resource-uuid in: path description: Unique ID of a license resource. required: true style: simple schema: type: string requestBody: description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLicensesLicense.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/license' - description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfLicensesLicense.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkGenericVnfsGenericVnfLicensesLicense description: > Update an existing license # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkGenericVnfsGenericVnfLicensesLicense parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: group-uuid in: path description: Unique ID for the license group the resource belongs to, should be uuid. required: true style: simple schema: type: string - name: resource-uuid in: path description: Unique ID of a license resource. required: true style: simple schema: type: string requestBody: description: license object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/license2' - description: license object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfLicensesLicense description: delete an existing license operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicense parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: group-uuid in: path description: Unique ID for the license group the resource belongs to, should be uuid. required: true style: simple schema: type: string - name: resource-uuid in: path description: Unique ID of a license resource. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/generic-vnfs/generic-vnf/{vnf-id}/licenses: get: tags: - Network summary: getNetworkGenericVnfsGenericVnfLicenses description: returns licenses operationId: getNetworkGenericVnfsGenericVnfLicenses parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: group-uuid in: query description: '' style: form explode: true schema: type: string - name: resource-uuid in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/licenses1' - description: Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: group-uuid in: path description: Unique ID for the entitlement group the resource comes from, should be uuid. required: true style: simple schema: type: string - name: resource-uuid in: path description: Unique ID of an entitlement resource. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: group-uuid in: path description: Unique ID for the entitlement group the resource comes from, should be uuid. required: true style: simple schema: type: string - name: resource-uuid in: path description: Unique ID of an entitlement resource. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}: get: tags: - Network summary: getNetworkGenericVnfsGenericVnfEntitlementsEntitlement description: returns entitlement operationId: getNetworkGenericVnfsGenericVnfEntitlementsEntitlement parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: group-uuid in: path description: Unique ID for the entitlement group the resource comes from, should be uuid. required: true style: simple schema: type: string - name: resource-uuid in: path description: Unique ID of an entitlement resource. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/entitlement1' - description: >- Metadata for entitlement group. ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement description: > Create or update an existing entitlement. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: group-uuid in: path description: Unique ID for the entitlement group the resource comes from, should be uuid. required: true style: simple schema: type: string - name: resource-uuid in: path description: Unique ID of an entitlement resource. required: true style: simple schema: type: string requestBody: description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/entitlement' - description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement description: > Update an existing entitlement # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: group-uuid in: path description: Unique ID for the entitlement group the resource comes from, should be uuid. required: true style: simple schema: type: string - name: resource-uuid in: path description: Unique ID of an entitlement resource. required: true style: simple schema: type: string requestBody: description: entitlement object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/entitlement2' - description: entitlement object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlement description: delete an existing entitlement operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlement parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: group-uuid in: path description: Unique ID for the entitlement group the resource comes from, should be uuid. required: true style: simple schema: type: string - name: resource-uuid in: path description: Unique ID of an entitlement resource. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements: get: tags: - Network summary: getNetworkGenericVnfsGenericVnfEntitlements description: returns entitlements operationId: getNetworkGenericVnfsGenericVnfEntitlements parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: group-uuid in: query description: '' style: form explode: true schema: type: string - name: resource-uuid in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/entitlements1' - description: Entitlements, keyed by group-uuid and resource-uuid, related to license management default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/generic-vnfs/generic-vnf/{vnf-id}: get: tags: - Network summary: getNetworkGenericVnfsGenericVnf description: returns generic-vnf operationId: getNetworkGenericVnfsGenericVnf parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/generic-vnf1' - description: >- General purpose VNF ###### Related Nodes - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY) - TO cloud-region( generic-vnf LocatedIn cloud-region, MANY2ONE) - TO complex( generic-vnf LocatedIn complex, MANY2MANY) - TO configuration( generic-vnf Uses configuration, ONE2MANY)(2) - TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY) - TO esr-vnfm( generic-vnf DependsOn esr-vnfm, MANY2ONE) - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY) - TO instance-group( generic-vnf Uses instance-group, ONE2MANY) - TO 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 tenant( generic-vnf BelongsTo tenant, MANY2ONE) - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY) - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE) - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY) - TO vserver( generic-vnf HostedOn vserver, ONE2MANY) - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY) - FROM contact( contact supports generic-vnf, MANY2MANY) - FROM device( device Uses generic-vnf, ONE2MANY) For CCVPN Usecase - FROM entitlement (CHILD of generic-vnf, entitlement BelongsTo generic-vnf, MANY2ONE)(1) - FROM forwarder( forwarder AppliesTo generic-vnf, MANY2MANY) Points to the generic-vnf(s) involved in this forwarding step. - FROM 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 metadatum( metadatum AppliesTo generic-vnf, MANY2MANY) AAI-2154 For BBS Usecase - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY) - FROM platform( platform Uses generic-vnf, MANY2MANY) - FROM 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkGenericVnfsGenericVnf description: > Create or update an existing generic-vnf. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkGenericVnfsGenericVnf parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string requestBody: description: generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnf.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/generic-vnf' - description: generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkGenericVnfsGenericVnf.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkGenericVnfsGenericVnf description: > Update an existing generic-vnf # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkGenericVnfsGenericVnf parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string requestBody: description: generic-vnf object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/generic-vnf2' - description: generic-vnf object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkGenericVnfsGenericVnf description: delete an existing generic-vnf operationId: deleteNetworkGenericVnfsGenericVnf parameters: - name: vnf-id in: path description: Unique id of VNF. This is unique across the graph. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/generic-vnfs: get: tags: - Network summary: getNetworkGenericVnfs description: returns generic-vnfs operationId: getNetworkGenericVnfs parameters: - name: vnf-id in: query description: '' style: form explode: true schema: type: string - name: vnf-name in: query description: '' style: form explode: true schema: type: string - name: vnf-name2 in: query description: '' style: form explode: true schema: type: string - name: vnf-type in: query description: '' style: form explode: true schema: type: string - name: service-id in: query description: '' style: form explode: true schema: type: string - name: regional-resource-zone in: query description: '' style: form explode: true schema: type: string - name: prov-status in: query description: '' style: form explode: true schema: type: string - name: heat-stack-id in: query description: '' style: form explode: true schema: type: string - name: in-maint in: query description: '' style: form explode: true schema: type: boolean - name: is-closed-loop-disabled in: query description: '' style: form explode: true schema: type: boolean - name: model-invariant-id in: query description: '' style: form explode: true schema: type: string - name: model-version-id in: query description: '' style: form explode: true schema: type: string - name: widget-model-id in: query description: '' style: form explode: true schema: type: string - name: widget-model-version in: query description: '' style: form explode: true schema: type: string - name: nf-type in: query description: '' style: form explode: true schema: type: string - name: nf-function in: query description: '' style: form explode: true schema: type: string - name: nf-role in: query description: '' style: form explode: true schema: type: string - name: nf-naming-code in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/generic-vnfs1' - description: Collection of VNFs default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/lag-links/lag-link/{link-name}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkLagLinksLagLinkRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkLagLinksLagLinkRelationshipListRelationship parameters: - name: link-name in: path description: Alphabetical concatenation of lag-interface names required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkLagLinksLagLink.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkLagLinksLagLink.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkLagLinksLagLinkRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkLagLinksLagLinkRelationshipListRelationship parameters: - name: link-name in: path description: Alphabetical concatenation of lag-interface names required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/lag-links/lag-link/{link-name}: get: tags: - Network summary: getNetworkLagLinksLagLink description: returns lag-link operationId: getNetworkLagLinksLagLink parameters: - name: link-name in: path description: Alphabetical concatenation of lag-interface names required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/lag-link1' - description: >- LAG links can connect lag-interfaces ###### Related Nodes - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3) - FROM logical-link( logical-link Uses lag-link, MANY2MANY) -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkLagLinksLagLink description: > Create or update an existing lag-link. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkLagLinksLagLink parameters: - name: link-name in: path description: Alphabetical concatenation of lag-interface names required: true style: simple schema: type: string requestBody: description: lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkLagLinksLagLink.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/lag-link' - description: lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkLagLinksLagLink.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkLagLinksLagLink description: > Update an existing lag-link # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkLagLinksLagLink parameters: - name: link-name in: path description: Alphabetical concatenation of lag-interface names required: true style: simple schema: type: string requestBody: description: lag-link object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/lag-link2' - description: lag-link object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkLagLinksLagLink description: delete an existing lag-link operationId: deleteNetworkLagLinksLagLink parameters: - name: link-name in: path description: Alphabetical concatenation of lag-interface names required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/lag-links: get: tags: - Network summary: getNetworkLagLinks description: returns lag-links operationId: getNetworkLagLinks parameters: - name: link-name in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/lag-links1' - description: Collection of link aggregation connections default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/newvces/newvce/{vnf-id2}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkNewvcesNewvceRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkNewvcesNewvceRelationshipListRelationship parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvce.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvce.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkNewvcesNewvceRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkNewvcesNewvceRelationshipListRelationship parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship : put: tags: - Network summary: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address} : get: tags: - Network summary: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: returns l3-interface-ipv4-address-list operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list1' - description: >- IPv4 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: > Create or update an existing l3-interface-ipv4-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list' - description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: > Update an existing l3-interface-ipv4-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list2' - description: l3-interface-ipv4-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: delete an existing l3-interface-ipv4-address-list operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address} : get: tags: - Network summary: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: returns l3-interface-ipv6-address-list operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list1' - description: >- IPv6 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: > Create or update an existing l3-interface-ipv6-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list' - description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: > Update an existing l3-interface-ipv6-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list2' - description: l3-interface-ipv6-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: delete an existing l3-interface-ipv6-address-list operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}: get: tags: - Network summary: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan description: returns vlan operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan1' - description: >- Definition of vlan ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan description: > Create or update an existing vlan. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string requestBody: description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan' - description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan description: > Update an existing vlan # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string requestBody: description: vlan object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan2' - description: vlan object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan description: delete an existing vlan operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans: get: tags: - Network summary: getNetworkNewvcesNewvceLInterfacesLInterfaceVlans description: returns vlans operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlans parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: vlan-interface in: query description: '' style: form explode: true schema: type: string - name: vlan-id-inner in: query description: '' style: form explode: true schema: type: integer format: int64 - name: vpn-key in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/vlans1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship : put: tags: - Network summary: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}: get: tags: - Network summary: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf description: returns sriov-vf operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vf1' - description: >- SR-IOV Virtual Function (not to be confused with virtual network function) ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf description: > Create or update an existing sriov-vf. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string requestBody: description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vf' - description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf description: > Update an existing sriov-vf # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string requestBody: description: sriov-vf object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vf2' - description: sriov-vf object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf description: delete an existing sriov-vf operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs: get: tags: - Network summary: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfs description: returns sriov-vfs operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfs parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: pci-id in: query description: '' style: form explode: true schema: type: string - name: vf-vlan-filter in: query description: '' style: form explode: true schema: type: string - name: vf-mac-filter in: query description: '' style: form explode: true schema: type: string - name: vf-vlan-strip in: query description: '' style: form explode: true schema: type: boolean - name: neutron-network-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vfs1' - description: Collection of SR-IOV Virtual Functions. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterface.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterface.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship : put: tags: - Network summary: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address} : get: tags: - Network summary: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList description: returns l3-interface-ipv4-address-list operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list1' - description: >- IPv4 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList description: > Create or update an existing l3-interface-ipv4-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list' - description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList description: > Update an existing l3-interface-ipv4-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list2' - description: l3-interface-ipv4-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList description: delete an existing l3-interface-ipv4-address-list operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship : put: tags: - Network summary: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address} : get: tags: - Network summary: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList description: returns l3-interface-ipv6-address-list operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list1' - description: >- IPv6 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList description: > Create or update an existing l3-interface-ipv6-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list' - description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList description: > Update an existing l3-interface-ipv6-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list2' - description: l3-interface-ipv6-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList description: delete an existing l3-interface-ipv6-address-list operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}: get: tags: - Network summary: getNetworkNewvcesNewvceLInterfacesLInterface description: returns l-interface operationId: getNetworkNewvcesNewvceLInterfacesLInterface parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interface1' - description: >- Logical interfaces, e.g., a vnic. ###### Related Nodes - 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 vrf( vrf Uses l-interface, ONE2MANY) - FROM l3-interface-ipv4-address-list (CHILD of l-interface, l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1) - FROM l3-interface-ipv6-address-list (CHILD of l-interface, l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1) - FROM lag-interface( lag-interface Uses l-interface, 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterface description: > Create or update an existing l-interface. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterface parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string requestBody: description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterface.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interface' - description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvceLInterfacesLInterface.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkNewvcesNewvceLInterfacesLInterface description: > Update an existing l-interface # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterface parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string requestBody: description: l-interface object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interface2' - description: l-interface object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkNewvcesNewvceLInterfacesLInterface description: delete an existing l-interface operationId: deleteNetworkNewvcesNewvceLInterfacesLInterface parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: path description: Name given to the interface required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/newvces/newvce/{vnf-id2}/l-interfaces: get: tags: - Network summary: getNetworkNewvcesNewvceLInterfaces description: returns l-interfaces operationId: getNetworkNewvcesNewvceLInterfaces parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: interface-name in: query description: '' style: form explode: true schema: type: string - name: interface-id in: query description: '' style: form explode: true schema: type: string - name: macaddr in: query description: '' style: form explode: true schema: type: string - name: network-name in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interfaces1' - description: Collection of logical interfaces. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/newvces/newvce/{vnf-id2}: get: tags: - Network summary: getNetworkNewvcesNewvce description: returns newvce operationId: getNetworkNewvcesNewvce parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/newvce1' - description: >- This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkNewvcesNewvce description: > Create or update an existing newvce. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkNewvcesNewvce parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string requestBody: description: newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvce.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/newvce' - description: newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNewvcesNewvce.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkNewvcesNewvce description: > Update an existing newvce # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkNewvcesNewvce parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string requestBody: description: newvce object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/newvce2' - description: newvce object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkNewvcesNewvce description: delete an existing newvce operationId: deleteNetworkNewvcesNewvce parameters: - name: vnf-id2 in: path description: Unique id of VNF, can't use same attribute name right now until we promote this new object required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/newvces: get: tags: - Network summary: getNetworkNewvces description: returns newvces operationId: getNetworkNewvces parameters: - name: vnf-id2 in: query description: '' style: form explode: true schema: type: string - name: vnf-name in: query description: '' style: form explode: true schema: type: string - name: vnf-name2 in: query description: '' style: form explode: true schema: type: string - name: vnf-type in: query description: '' style: form explode: true schema: type: string - name: prov-status in: query description: '' style: form explode: true schema: type: string - name: heat-stack-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/newvces1' - description: This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/pnfs/pnf/{pnf-name}/software-versions/software-version/{software-version-id}: get: tags: - Network summary: getNetworkPnfsPnfSoftwareVersionsSoftwareVersion description: returns software-version operationId: getNetworkPnfsPnfSoftwareVersionsSoftwareVersion parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: software-version-id in: path description: Identifier of the software version required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/software-version' - description: >- Software Version ###### Related Nodes - TO pnf (PARENT of software-version, software-version BelongsTo pnf, MANY2ONE) default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkPnfsPnfSoftwareVersionsSoftwareVersion description: > Create or update an existing software-version. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkPnfsPnfSoftwareVersionsSoftwareVersion parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: software-version-id in: path description: Identifier of the software version required: true style: simple schema: type: string requestBody: description: software-version object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfSoftwareVersionsSoftwareVersion.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/software-version' - description: software-version object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfSoftwareVersionsSoftwareVersion.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkPnfsPnfSoftwareVersionsSoftwareVersion description: > Update an existing software-version # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkPnfsPnfSoftwareVersionsSoftwareVersion parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: software-version-id in: path description: Identifier of the software version required: true style: simple schema: type: string requestBody: description: software-version object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/software-version' - description: software-version object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfSoftwareVersionsSoftwareVersion description: delete an existing software-version operationId: deleteNetworkPnfsPnfSoftwareVersionsSoftwareVersion parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: software-version-id in: path description: Identifier of the software version required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/pnfs/pnf/{pnf-name}/software-versions: get: tags: - Network summary: getNetworkPnfsPnfSoftwareVersions description: returns software-versions operationId: getNetworkPnfsPnfSoftwareVersions parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/software-versions' - description: Collection of software versions. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/pnfs/pnf/{pnf-name}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkPnfsPnfRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkPnfsPnfRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnf.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnf.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkPnfsPnfRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterface.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterface.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship : put: tags: - Network summary: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pf-pci-id in: path description: Identifier for the sriov-pf required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pf-pci-id in: path description: Identifier for the sriov-pf required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}: get: tags: - Network summary: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf description: returns sriov-pf operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pf-pci-id in: path description: Identifier for the sriov-pf required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-pf1' - description: >- SR-IOV Physical Function ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf description: > Create or update an existing sriov-pf. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pf-pci-id in: path description: Identifier for the sriov-pf required: true style: simple schema: type: string requestBody: description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-pf' - description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf description: > Update an existing sriov-pf # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pf-pci-id in: path description: Identifier for the sriov-pf required: true style: simple schema: type: string requestBody: description: sriov-pf object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-pf2' - description: sriov-pf object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf description: delete an existing sriov-pf operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pf-pci-id in: path description: Identifier for the sriov-pf required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs: get: tags: - Network summary: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfs description: returns sriov-pfs operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfs parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pf-pci-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-pfs1' - description: Collection of SR-IOV Physical Functions. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship : put: tags: - Network summary: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - Network summary: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: returns l3-interface-ipv4-address-list operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list1' - description: >- IPv4 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: > Create or update an existing l3-interface-ipv4-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list' - description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: > Update an existing l3-interface-ipv4-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list2' - description: l3-interface-ipv4-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: delete an existing l3-interface-ipv4-address-list operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - Network summary: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: returns l3-interface-ipv6-address-list operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list1' - description: >- IPv6 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: > Create or update an existing l3-interface-ipv6-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list' - description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: > Update an existing l3-interface-ipv6-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list2' - description: l3-interface-ipv6-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: delete an existing l3-interface-ipv6-address-list operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface} : get: tags: - Network summary: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan description: returns vlan operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan1' - description: >- Definition of vlan ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan description: > Create or update an existing vlan. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string requestBody: description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan' - description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan description: > Update an existing vlan # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string requestBody: description: vlan object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan2' - description: vlan object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan description: delete an existing vlan operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans: get: tags: - Network summary: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlans description: returns vlans operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlans parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: vlan-interface in: query description: '' style: form explode: true schema: type: string - name: vlan-id-inner in: query description: '' style: form explode: true schema: type: integer format: int64 - name: vpn-key in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/vlans1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id} : get: tags: - Network summary: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf description: returns sriov-vf operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vf1' - description: >- SR-IOV Virtual Function (not to be confused with virtual network function) ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf description: > Create or update an existing sriov-vf. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string requestBody: description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vf' - description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf description: > Update an existing sriov-vf # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string requestBody: description: sriov-vf object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vf2' - description: sriov-vf object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf description: delete an existing sriov-vf operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: get: tags: - Network summary: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs description: returns sriov-vfs operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: pci-id in: query description: '' style: form explode: true schema: type: string - name: vf-vlan-filter in: query description: '' style: form explode: true schema: type: string - name: vf-mac-filter in: query description: '' style: form explode: true schema: type: string - name: vf-vlan-strip in: query description: '' style: form explode: true schema: type: boolean - name: neutron-network-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vfs1' - description: Collection of SR-IOV Virtual Functions. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship : put: tags: - Network summary: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - Network summary: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList description: returns l3-interface-ipv4-address-list operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list1' - description: >- IPv4 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList description: > Create or update an existing l3-interface-ipv4-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list' - description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList description: > Update an existing l3-interface-ipv4-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list2' - description: l3-interface-ipv4-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList description: delete an existing l3-interface-ipv4-address-list operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - Network summary: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList description: returns l3-interface-ipv6-address-list operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list1' - description: >- IPv6 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList description: > Create or update an existing l3-interface-ipv6-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list' - description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList description: > Update an existing l3-interface-ipv6-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list2' - description: l3-interface-ipv6-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList description: delete an existing l3-interface-ipv6-address-list operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}: get: tags: - Network summary: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface description: returns l-interface operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interface1' - description: >- Logical interfaces, e.g., a vnic. ###### Related Nodes - 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 vrf( vrf Uses l-interface, ONE2MANY) - FROM l3-interface-ipv4-address-list (CHILD of l-interface, l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1) - FROM l3-interface-ipv6-address-list (CHILD of l-interface, l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1) - FROM lag-interface( lag-interface Uses l-interface, 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface description: > Create or update an existing l-interface. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string requestBody: description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interface' - description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface description: > Update an existing l-interface # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string requestBody: description: l-interface object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interface2' - description: l-interface object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface description: delete an existing l-interface operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces: get: tags: - Network summary: getNetworkPnfsPnfPInterfacesPInterfaceLInterfaces description: returns l-interfaces operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfaces parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: interface-id in: query description: '' style: form explode: true schema: type: string - name: macaddr in: query description: '' style: form explode: true schema: type: string - name: network-name in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interfaces1' - description: Collection of logical interfaces. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}: get: tags: - Network summary: getNetworkPnfsPnfPInterfacesPInterface description: returns p-interface operationId: getNetworkPnfsPnfPInterfacesPInterface parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/p-interface1' - description: >- Physical interface (e.g., nic) ###### Related Nodes - 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 allotted-resource( allotted-resource Uses p-interface, ONE2MANY) AAI-1925 For CCVPN Usecase - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkPnfsPnfPInterfacesPInterface description: > Create or update an existing p-interface. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterface parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string requestBody: description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterface.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/p-interface' - description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfPInterfacesPInterface.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkPnfsPnfPInterfacesPInterface description: > Update an existing p-interface # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkPnfsPnfPInterfacesPInterface parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string requestBody: description: p-interface object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/p-interface2' - description: p-interface object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfPInterfacesPInterface description: delete an existing p-interface operationId: deleteNetworkPnfsPnfPInterfacesPInterface parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the physical interface required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/pnfs/pnf/{pnf-name}/p-interfaces: get: tags: - Network summary: getNetworkPnfsPnfPInterfaces description: returns p-interfaces operationId: getNetworkPnfsPnfPInterfaces parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: query description: '' style: form explode: true schema: type: string - name: prov-status in: query description: '' style: form explode: true schema: type: string - name: operational-status in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/p-interfaces1' - description: Collection of physical interfaces. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterface.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterface.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship : put: tags: - Network summary: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - Network summary: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: returns l3-interface-ipv4-address-list operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list1' - description: >- IPv4 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: > Create or update an existing l3-interface-ipv4-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list' - description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: > Update an existing l3-interface-ipv4-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list2' - description: l3-interface-ipv4-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList description: delete an existing l3-interface-ipv4-address-list operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - Network summary: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: returns l3-interface-ipv6-address-list operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list1' - description: >- IPv6 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: > Create or update an existing l3-interface-ipv6-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list' - description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: > Update an existing l3-interface-ipv6-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list2' - description: l3-interface-ipv6-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList description: delete an existing l3-interface-ipv6-address-list operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface} : get: tags: - Network summary: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan description: returns vlan operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan1' - description: >- Definition of vlan ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan description: > Create or update an existing vlan. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string requestBody: description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan' - description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan description: > Update an existing vlan # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string requestBody: description: vlan object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan2' - description: vlan object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan description: delete an existing vlan operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: path description: String that identifies the interface required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans: get: tags: - Network summary: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans description: returns vlans operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: vlan-interface in: query description: '' style: form explode: true schema: type: string - name: vlan-id-inner in: query description: '' style: form explode: true schema: type: integer format: int64 - name: vpn-key in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/vlans1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id} : get: tags: - Network summary: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf description: returns sriov-vf operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vf1' - description: >- SR-IOV Virtual Function (not to be confused with virtual network function) ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf description: > Create or update an existing sriov-vf. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string requestBody: description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vf' - description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf description: > Update an existing sriov-vf # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string requestBody: description: sriov-vf object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vf2' - description: sriov-vf object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf description: delete an existing sriov-vf operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: pci-id in: path description: PCI ID used to identify the sriov-vf required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs: get: tags: - Network summary: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs description: returns sriov-vfs operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: pci-id in: query description: '' style: form explode: true schema: type: string - name: vf-vlan-filter in: query description: '' style: form explode: true schema: type: string - name: vf-mac-filter in: query description: '' style: form explode: true schema: type: string - name: vf-vlan-strip in: query description: '' style: form explode: true schema: type: boolean - name: neutron-network-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sriov-vfs1' - description: Collection of SR-IOV Virtual Functions. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship : put: tags: - Network summary: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - Network summary: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList description: returns l3-interface-ipv4-address-list operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list1' - description: >- IPv4 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList description: > Create or update an existing l3-interface-ipv4-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list' - description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList description: > Update an existing l3-interface-ipv4-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv4-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv4-address-list2' - description: l3-interface-ipv4-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList description: delete an existing l3-interface-ipv4-address-list operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv4-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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 : put: tags: - Network summary: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /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} : get: tags: - Network summary: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList description: returns l3-interface-ipv6-address-list operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list1' - description: >- IPv6 Address Range ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList description: > Create or update an existing l3-interface-ipv6-address-list. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list' - description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList description: > Update an existing l3-interface-ipv6-address-list # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string requestBody: description: l3-interface-ipv6-address-list object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l3-interface-ipv6-address-list2' - description: l3-interface-ipv6-address-list object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList description: delete an existing l3-interface-ipv6-address-list operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: l3-interface-ipv6-address in: path description: IP address required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}: get: tags: - Network summary: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface description: returns l-interface operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interface1' - description: >- Logical interfaces, e.g., a vnic. ###### Related Nodes - 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 vrf( vrf Uses l-interface, ONE2MANY) - FROM l3-interface-ipv4-address-list (CHILD of l-interface, l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1) - FROM l3-interface-ipv6-address-list (CHILD of l-interface, l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1) - FROM lag-interface( lag-interface Uses l-interface, 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface description: > Create or update an existing l-interface. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string requestBody: description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interface' - description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface description: > Update an existing l-interface # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string requestBody: description: l-interface object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interface2' - description: l-interface object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface description: delete an existing l-interface operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces: get: tags: - Network summary: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces description: returns l-interfaces operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: interface-id in: query description: '' style: form explode: true schema: type: string - name: macaddr in: query description: '' style: form explode: true schema: type: string - name: network-name in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/l-interfaces1' - description: Collection of logical interfaces. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}: get: tags: - Network summary: getNetworkPnfsPnfLagInterfacesLagInterface description: returns lag-interface operationId: getNetworkPnfsPnfLagInterfacesLagInterface parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/lag-interface1' - description: >- Link aggregate interface ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterface description: > Create or update an existing lag-interface. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterface parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string requestBody: description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterface.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/lag-interface' - description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfLagInterfacesLagInterface.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkPnfsPnfLagInterfacesLagInterface description: > Update an existing lag-interface # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterface parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string requestBody: description: lag-interface object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/lag-interface2' - description: lag-interface object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfLagInterfacesLagInterface description: delete an existing lag-interface operationId: deleteNetworkPnfsPnfLagInterfacesLagInterface parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: path description: Name that identifies the link aggregate interface required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/pnfs/pnf/{pnf-name}/lag-interfaces: get: tags: - Network summary: getNetworkPnfsPnfLagInterfaces description: returns lag-interfaces operationId: getNetworkPnfsPnfLagInterfaces parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: interface-name in: query description: '' style: form explode: true schema: type: string - name: interface-id in: query description: '' style: form explode: true schema: type: string - name: interface-role in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/lag-interfaces1' - description: Collection of link aggregate interfaces. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship : put: tags: - Network summary: createOrUpdateNetworkPnfsPnfVrfsVrfRouteTargetsRouteTargetRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkPnfsPnfVrfsVrfRouteTargetsRouteTargetRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: vrf-id in: path description: VRF UUID. required: true style: simple schema: type: string - name: global-route-target in: path description: Number used to identify an RT, globally unique in the network required: true style: simple schema: type: string - name: route-target-role in: path description: Role assigned to this route target required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfVrfsVrfRouteTargetsRouteTarget.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfVrfsVrfRouteTargetsRouteTarget.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfVrfsVrfRouteTargetsRouteTargetRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkPnfsPnfVrfsVrfRouteTargetsRouteTargetRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: vrf-id in: path description: VRF UUID. required: true style: simple schema: type: string - name: global-route-target in: path description: Number used to identify an RT, globally unique in the network required: true style: simple schema: type: string - name: route-target-role in: path description: Role assigned to this route target required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/route-targets/route-target/{global-route-target}/{route-target-role}: get: tags: - Network summary: getNetworkPnfsPnfVrfsVrfRouteTargetsRouteTarget description: returns route-target operationId: getNetworkPnfsPnfVrfsVrfRouteTargetsRouteTarget parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: vrf-id in: path description: VRF UUID. required: true style: simple schema: type: string - name: global-route-target in: path description: Number used to identify an RT, globally unique in the network required: true style: simple schema: type: string - name: route-target-role in: path description: Role assigned to this route target required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/route-target1' - description: >- Route target information ###### Related Nodes - TO vpn-binding (PARENT of route-target, route-target BelongsTo vpn-binding, MANY2ONE)(4) - TO vrf (PARENT of route-target, route-target BelongsTo vrf, MANY2ONE)(4) -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkPnfsPnfVrfsVrfRouteTargetsRouteTarget description: > Create or update an existing route-target. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkPnfsPnfVrfsVrfRouteTargetsRouteTarget parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: vrf-id in: path description: VRF UUID. required: true style: simple schema: type: string - name: global-route-target in: path description: Number used to identify an RT, globally unique in the network required: true style: simple schema: type: string - name: route-target-role in: path description: Role assigned to this route target required: true style: simple schema: type: string requestBody: description: route-target object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfVrfsVrfRouteTargetsRouteTarget.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/route-target' - description: route-target object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfVrfsVrfRouteTargetsRouteTarget.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkPnfsPnfVrfsVrfRouteTargetsRouteTarget description: > Update an existing route-target # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkPnfsPnfVrfsVrfRouteTargetsRouteTarget parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: vrf-id in: path description: VRF UUID. required: true style: simple schema: type: string - name: global-route-target in: path description: Number used to identify an RT, globally unique in the network required: true style: simple schema: type: string - name: route-target-role in: path description: Role assigned to this route target required: true style: simple schema: type: string requestBody: description: route-target object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/route-target2' - description: route-target object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfVrfsVrfRouteTargetsRouteTarget description: delete an existing route-target operationId: deleteNetworkPnfsPnfVrfsVrfRouteTargetsRouteTarget parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: vrf-id in: path description: VRF UUID. required: true style: simple schema: type: string - name: global-route-target in: path description: Number used to identify an RT, globally unique in the network required: true style: simple schema: type: string - name: route-target-role in: path description: Role assigned to this route target required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/route-targets: get: tags: - Network summary: getNetworkPnfsPnfVrfsVrfRouteTargets description: returns route-targets operationId: getNetworkPnfsPnfVrfsVrfRouteTargets parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: vrf-id in: path description: VRF UUID. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/route-targets1' - description: Collection of route target information default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkPnfsPnfVrfsVrfRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkPnfsPnfVrfsVrfRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: vrf-id in: path description: VRF UUID. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfVrfsVrf.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfVrfsVrf.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfVrfsVrfRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkPnfsPnfVrfsVrfRelationshipListRelationship parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: vrf-id in: path description: VRF UUID. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/pnfs/pnf/{pnf-name}/vrfs/vrf/{vrf-id}: get: tags: - Network summary: getNetworkPnfsPnfVrfsVrf description: returns vrf operationId: getNetworkPnfsPnfVrfsVrf parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: vrf-id in: path description: VRF UUID. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/vrf1' - description: >- Definition of vrf ###### Related Nodes - TO l-interface( vrf Uses l-interface, ONE2MANY) - TO l3-network( vrf Uses l3-network, ONE2MANY) A vrf uses many l3-networks - TO pnf (PARENT of vrf, vrf BelongsTo pnf, MANY2ONE) A vrf belongs to a pnf.(4) - TO vpn-binding( vrf AppliesTo vpn-binding, MANY2ONE) A vrf uses a vpn-binding. - FROM configuration( configuration Uses vrf, ONE2MANY) A Configuration uses VRFs - FROM route-target (CHILD of vrf, route-target BelongsTo vrf, MANY2ONE)(1) -(1) IF this VRF node is deleted, this FROM node is DELETED also -(4) IF this TO node is deleted, this VRF is DELETED also default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkPnfsPnfVrfsVrf description: > Create or update an existing vrf. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkPnfsPnfVrfsVrf parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: vrf-id in: path description: VRF UUID. required: true style: simple schema: type: string requestBody: description: vrf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfVrfsVrf.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/vrf' - description: vrf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnfVrfsVrf.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkPnfsPnfVrfsVrf description: > Update an existing vrf # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkPnfsPnfVrfsVrf parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: vrf-id in: path description: VRF UUID. required: true style: simple schema: type: string requestBody: description: vrf object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/vrf2' - description: vrf object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnfVrfsVrf description: delete an existing vrf operationId: deleteNetworkPnfsPnfVrfsVrf parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: vrf-id in: path description: VRF UUID. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/pnfs/pnf/{pnf-name}/vrfs: get: tags: - Network summary: getNetworkPnfsPnfVrfs description: returns vrfs operationId: getNetworkPnfsPnfVrfs parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: vrf-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/vrfs1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/pnfs/pnf/{pnf-name}: get: tags: - Network summary: getNetworkPnfsPnf description: returns pnf operationId: getNetworkPnfsPnf parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/pnf1' - description: >- 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. ###### Related Nodes - 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 metadatum( metadatum AppliesTo pnf, MANY2MANY) AAI-2154 For BBS Usecase - 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) - FROM vrf (CHILD of pnf, vrf BelongsTo pnf, MANY2ONE) A vrf belongs to a pnf.(1) -(1) IF this PNF node is deleted, this FROM node is DELETED also -(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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkPnfsPnf description: > Create or update an existing pnf. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkPnfsPnf parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string requestBody: description: pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnf.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/pnf' - description: pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPnfsPnf.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkPnfsPnf description: > Update an existing pnf # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkPnfsPnf parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string requestBody: description: pnf object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/pnf2' - description: pnf object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPnfsPnf description: delete an existing pnf operationId: deleteNetworkPnfsPnf parameters: - name: pnf-name in: path description: unique name of Physical Network Function. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/pnfs: get: tags: - Network summary: getNetworkPnfs description: returns pnfs operationId: getNetworkPnfs parameters: - name: pnf-name in: query description: '' style: form explode: true schema: type: string - name: orchestration-status in: query description: '' style: form explode: true schema: type: string - name: inv-status in: query description: '' style: form explode: true schema: type: string - name: admin-status in: query description: '' style: form explode: true schema: type: string - name: operational-status in: query description: '' style: form explode: true schema: type: string - name: model-invariant-id in: query description: '' style: form explode: true schema: type: string - name: model-version-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/pnfs1' - description: Collection of Physical Network Functions. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/physical-links/physical-link/{link-name}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship parameters: - name: link-name in: path description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPhysicalLinksPhysicalLink.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPhysicalLinksPhysicalLink.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship parameters: - name: link-name in: path description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/physical-links/physical-link/{link-name}: get: tags: - Network summary: getNetworkPhysicalLinksPhysicalLink description: returns physical-link operationId: getNetworkPhysicalLinksPhysicalLink parameters: - name: link-name in: path description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/physical-link1' - description: >- Collection of physical connections, typically between p-interfaces ###### Related Nodes - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3) -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkPhysicalLinksPhysicalLink description: > Create or update an existing physical-link. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkPhysicalLinksPhysicalLink parameters: - name: link-name in: path description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ required: true style: simple schema: type: string requestBody: description: physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPhysicalLinksPhysicalLink.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/physical-link' - description: physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkPhysicalLinksPhysicalLink.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkPhysicalLinksPhysicalLink description: > Update an existing physical-link # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkPhysicalLinksPhysicalLink parameters: - name: link-name in: path description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ required: true style: simple schema: type: string requestBody: description: physical-link object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/physical-link2' - description: physical-link object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkPhysicalLinksPhysicalLink description: delete an existing physical-link operationId: deleteNetworkPhysicalLinksPhysicalLink parameters: - name: link-name in: path description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/physical-links: get: tags: - Network summary: getNetworkPhysicalLinks description: returns physical-links operationId: getNetworkPhysicalLinks parameters: - name: link-name in: query description: '' style: form explode: true schema: type: string - name: circuit-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/physical-links1' - description: Collection of physical connections, typically between p-interfaces default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship parameters: - name: ipsec-configuration-id in: path description: UUID of this configuration required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkIpsecConfigurationsIpsecConfiguration.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkIpsecConfigurationsIpsecConfiguration.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship parameters: - name: ipsec-configuration-id in: path description: UUID of this configuration required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship : put: tags: - Network summary: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship parameters: - name: ipsec-configuration-id in: path description: UUID of this configuration required: true style: simple schema: type: string - name: vig-address-type in: path description: indicates whether the VIG is for AVPN or INTERNET required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship parameters: - name: ipsec-configuration-id in: path description: UUID of this configuration required: true style: simple schema: type: string - name: vig-address-type in: path description: indicates whether the VIG is for AVPN or INTERNET required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}: get: tags: - Network summary: getNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer description: returns vig-server operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer parameters: - name: ipsec-configuration-id in: path description: UUID of this configuration required: true style: simple schema: type: string - name: vig-address-type in: path description: indicates whether the VIG is for AVPN or INTERNET required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/vig-server1' - description: >- vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607 ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer description: > Create or update an existing vig-server. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer parameters: - name: ipsec-configuration-id in: path description: UUID of this configuration required: true style: simple schema: type: string - name: vig-address-type in: path description: indicates whether the VIG is for AVPN or INTERNET required: true style: simple schema: type: string requestBody: description: vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/vig-server' - description: vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer description: > Update an existing vig-server # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer parameters: - name: ipsec-configuration-id in: path description: UUID of this configuration required: true style: simple schema: type: string - name: vig-address-type in: path description: indicates whether the VIG is for AVPN or INTERNET required: true style: simple schema: type: string requestBody: description: vig-server object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/vig-server2' - description: vig-server object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer description: delete an existing vig-server operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer parameters: - name: ipsec-configuration-id in: path description: UUID of this configuration required: true style: simple schema: type: string - name: vig-address-type in: path description: indicates whether the VIG is for AVPN or INTERNET required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers: get: tags: - Network summary: getNetworkIpsecConfigurationsIpsecConfigurationVigServers description: returns vig-servers operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServers parameters: - name: ipsec-configuration-id in: path description: UUID of this configuration required: true style: simple schema: type: string - name: vig-address-type in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/vig-servers1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}: get: tags: - Network summary: getNetworkIpsecConfigurationsIpsecConfiguration description: returns ipsec-configuration operationId: getNetworkIpsecConfigurationsIpsecConfiguration parameters: - name: ipsec-configuration-id in: path description: UUID of this configuration required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/ipsec-configuration1' - description: >- 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 ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkIpsecConfigurationsIpsecConfiguration description: > Create or update an existing ipsec-configuration. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfiguration parameters: - name: ipsec-configuration-id in: path description: UUID of this configuration required: true style: simple schema: type: string requestBody: description: ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkIpsecConfigurationsIpsecConfiguration.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/ipsec-configuration' - description: ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkIpsecConfigurationsIpsecConfiguration.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkIpsecConfigurationsIpsecConfiguration description: > Update an existing ipsec-configuration # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkIpsecConfigurationsIpsecConfiguration parameters: - name: ipsec-configuration-id in: path description: UUID of this configuration required: true style: simple schema: type: string requestBody: description: ipsec-configuration object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/ipsec-configuration2' - description: ipsec-configuration object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkIpsecConfigurationsIpsecConfiguration description: delete an existing ipsec-configuration operationId: deleteNetworkIpsecConfigurationsIpsecConfiguration parameters: - name: ipsec-configuration-id in: path description: UUID of this configuration required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/ipsec-configurations: get: tags: - Network summary: getNetworkIpsecConfigurations description: returns ipsec-configurations operationId: getNetworkIpsecConfigurations parameters: - name: ipsec-configuration-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/ipsec-configurations1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship parameters: - name: route-table-reference-id in: path description: Route Table Reference id, UUID assigned to this instance. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkRouteTableReferencesRouteTableReference.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkRouteTableReferencesRouteTableReference.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship parameters: - name: route-table-reference-id in: path description: Route Table Reference id, UUID assigned to this instance. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/route-table-references/route-table-reference/{route-table-reference-id}: get: tags: - Network summary: getNetworkRouteTableReferencesRouteTableReference description: returns route-table-reference operationId: getNetworkRouteTableReferencesRouteTableReference parameters: - name: route-table-reference-id in: path description: Route Table Reference id, UUID assigned to this instance. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/route-table-reference1' - description: >- Openstack route table reference. ###### Related Nodes - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY) default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkRouteTableReferencesRouteTableReference description: > Create or update an existing route-table-reference. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReference parameters: - name: route-table-reference-id in: path description: Route Table Reference id, UUID assigned to this instance. required: true style: simple schema: type: string requestBody: description: route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkRouteTableReferencesRouteTableReference.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/route-table-reference' - description: route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkRouteTableReferencesRouteTableReference.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkRouteTableReferencesRouteTableReference description: > Update an existing route-table-reference # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkRouteTableReferencesRouteTableReference parameters: - name: route-table-reference-id in: path description: Route Table Reference id, UUID assigned to this instance. required: true style: simple schema: type: string requestBody: description: route-table-reference object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/route-table-reference2' - description: route-table-reference object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkRouteTableReferencesRouteTableReference description: delete an existing route-table-reference operationId: deleteNetworkRouteTableReferencesRouteTableReference parameters: - name: route-table-reference-id in: path description: Route Table Reference id, UUID assigned to this instance. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/route-table-references: get: tags: - Network summary: getNetworkRouteTableReferences description: returns route-table-references operationId: getNetworkRouteTableReferences parameters: - name: route-table-reference-id in: query description: '' style: form explode: true schema: type: string - name: route-table-reference-fqdn in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/route-table-references1' - description: Collection of openstack route table references default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/instance-groups/instance-group/{id}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkInstanceGroupsInstanceGroupRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkInstanceGroupsInstanceGroupRelationshipListRelationship parameters: - name: id in: path description: Instance Group ID, UUID assigned to this instance. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkInstanceGroupsInstanceGroup.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkInstanceGroupsInstanceGroup.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkInstanceGroupsInstanceGroupRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkInstanceGroupsInstanceGroupRelationshipListRelationship parameters: - name: id in: path description: Instance Group ID, UUID assigned to this instance. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/instance-groups/instance-group/{id}: get: tags: - Network summary: getNetworkInstanceGroupsInstanceGroup description: returns instance-group operationId: getNetworkInstanceGroupsInstanceGroup parameters: - name: id in: path description: Instance Group ID, UUID assigned to this instance. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/instance-group1' - description: >- General mechanism for grouping instances ###### Related Nodes - 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 Uses instance-group, ONE2MANY) MSO creates this edge on VNF Group Service creation - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY) - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY) - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY) - FROM vnfc( vnfc MemberOf instance-group, MANY2MANY) -(4) IF this TO node is deleted, this INSTANCE-GROUP is DELETED also default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkInstanceGroupsInstanceGroup description: > Create or update an existing instance-group. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkInstanceGroupsInstanceGroup parameters: - name: id in: path description: Instance Group ID, UUID assigned to this instance. required: true style: simple schema: type: string requestBody: description: instance-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkInstanceGroupsInstanceGroup.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/instance-group' - description: instance-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkInstanceGroupsInstanceGroup.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkInstanceGroupsInstanceGroup description: > Update an existing instance-group # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkInstanceGroupsInstanceGroup parameters: - name: id in: path description: Instance Group ID, UUID assigned to this instance. required: true style: simple schema: type: string requestBody: description: instance-group object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/instance-group2' - description: instance-group object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkInstanceGroupsInstanceGroup description: delete an existing instance-group operationId: deleteNetworkInstanceGroupsInstanceGroup parameters: - name: id in: path description: Instance Group ID, UUID assigned to this instance. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/instance-groups: get: tags: - Network summary: getNetworkInstanceGroups description: returns instance-groups operationId: getNetworkInstanceGroups parameters: - name: id in: query description: '' style: form explode: true schema: type: string - name: model-invariant-id in: query description: '' style: form explode: true schema: type: string - name: model-version-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/instance-groups1' - description: Collection of openstack route table references default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/zones/zone/{zone-id}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkZonesZoneRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkZonesZoneRelationshipListRelationship parameters: - name: zone-id in: path description: Code assigned by AIC to the zone required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkZonesZone.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkZonesZone.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkZonesZoneRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkZonesZoneRelationshipListRelationship parameters: - name: zone-id in: path description: Code assigned by AIC to the zone required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/zones/zone/{zone-id}: get: tags: - Network summary: getNetworkZonesZone description: returns zone operationId: getNetworkZonesZone parameters: - name: zone-id in: path description: Code assigned by AIC to the zone required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/zone1' - description: >- A zone is a grouping of assets in a location homing to the same connections into the CBB ###### Related Nodes - 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) default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkZonesZone description: > Create or update an existing zone. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkZonesZone parameters: - name: zone-id in: path description: Code assigned by AIC to the zone required: true style: simple schema: type: string requestBody: description: zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkZonesZone.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/zone' - description: zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkZonesZone.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkZonesZone description: > Update an existing zone # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkZonesZone parameters: - name: zone-id in: path description: Code assigned by AIC to the zone required: true style: simple schema: type: string requestBody: description: zone object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/zone2' - description: zone object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkZonesZone description: delete an existing zone operationId: deleteNetworkZonesZone parameters: - name: zone-id in: path description: Code assigned by AIC to the zone required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/zones: get: tags: - Network summary: getNetworkZones description: returns zones operationId: getNetworkZones parameters: - name: zone-id in: query description: '' style: form explode: true schema: type: string - name: design-type in: query description: '' style: form explode: true schema: type: string - name: zone-context in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/zones1' - description: Collection of zones default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/configurations/configuration/{configuration-id}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkConfigurationsConfigurationRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkConfigurationsConfigurationRelationshipListRelationship parameters: - name: configuration-id in: path description: UUID assigned to configuration. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkConfigurationsConfiguration.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkConfigurationsConfiguration.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkConfigurationsConfigurationRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkConfigurationsConfigurationRelationshipListRelationship parameters: - name: configuration-id in: path description: UUID assigned to configuration. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}: get: tags: - Network summary: getNetworkConfigurationsConfigurationMetadataMetadatum description: returns metadatum operationId: getNetworkConfigurationsConfigurationMetadataMetadatum parameters: - name: configuration-id in: path description: UUID assigned to configuration. required: true style: simple schema: type: string - name: metaname in: path description: '' required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/metadatum' - description: >- Key/value pairs ###### Related Nodes - TO configuration (PARENT of metadatum, metadatum BelongsTo configuration, MANY2ONE)(4) - TO connector (PARENT of metadatum, metadatum BelongsTo connector, MANY2ONE)(4) - TO cp( metadatum AppliesTo cp, MANY2MANY) AAI-2154 For BBS Usecase - TO generic-vnf( metadatum AppliesTo generic-vnf, MANY2MANY) AAI-2154 For BBS Usecase - TO image (PARENT of metadatum, metadatum BelongsTo image, MANY2ONE)(4) - TO model-ver (PARENT of metadatum, metadatum BelongsTo model-ver, MANY2ONE)(4) - TO pnf( metadatum AppliesTo pnf, MANY2MANY) AAI-2154 For BBS Usecase - TO service-instance (PARENT of metadatum, metadatum BelongsTo service-instance, MANY2ONE)(4) -(4) IF this TO node is deleted, this METADATUM is DELETED also default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkConfigurationsConfigurationMetadataMetadatum description: > Create or update an existing metadatum. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkConfigurationsConfigurationMetadataMetadatum parameters: - name: configuration-id in: path description: UUID assigned to configuration. required: true style: simple schema: type: string - name: metaname in: path description: '' required: true style: simple schema: type: string requestBody: description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkConfigurationsConfigurationMetadataMetadatum.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/metadatum' - description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkConfigurationsConfigurationMetadataMetadatum.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkConfigurationsConfigurationMetadataMetadatum description: > Update an existing metadatum # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkConfigurationsConfigurationMetadataMetadatum parameters: - name: configuration-id in: path description: UUID assigned to configuration. required: true style: simple schema: type: string - name: metaname in: path description: '' required: true style: simple schema: type: string requestBody: description: metadatum object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/metadatum2' - description: metadatum object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkConfigurationsConfigurationMetadataMetadatum description: delete an existing metadatum operationId: deleteNetworkConfigurationsConfigurationMetadataMetadatum parameters: - name: configuration-id in: path description: UUID assigned to configuration. required: true style: simple schema: type: string - name: metaname in: path description: '' required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/configurations/configuration/{configuration-id}/metadata: get: tags: - Network summary: getNetworkConfigurationsConfigurationMetadata description: returns metadata operationId: getNetworkConfigurationsConfigurationMetadata parameters: - name: configuration-id in: path description: UUID assigned to configuration. required: true style: simple schema: type: string - name: metaname in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/metadata' - description: Collection of metadatum (key/value pairs) default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/vlan-mappings/vlan-mapping/{vlan-mapping-id}/relationship-list/relationship : put: tags: - Network summary: createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcVlanMappingsVlanMappingRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcVlanMappingsVlanMappingRelationshipListRelationship parameters: - name: configuration-id in: path description: UUID assigned to configuration. required: true style: simple schema: type: string - name: forwarder-evc-id in: path description: Key for forwarder-evc object required: true style: simple schema: type: string - name: vlan-mapping-id in: path description: Key for vlan-mapping object. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkConfigurationsConfigurationForwarderEvcsForwarderEvcVlanMappingsVlanMapping.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkConfigurationsConfigurationForwarderEvcsForwarderEvcVlanMappingsVlanMapping.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcVlanMappingsVlanMappingRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcVlanMappingsVlanMappingRelationshipListRelationship parameters: - name: configuration-id in: path description: UUID assigned to configuration. required: true style: simple schema: type: string - name: forwarder-evc-id in: path description: Key for forwarder-evc object required: true style: simple schema: type: string - name: vlan-mapping-id in: path description: Key for vlan-mapping object. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/vlan-mappings/vlan-mapping/{vlan-mapping-id} : get: tags: - Network summary: getNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcVlanMappingsVlanMapping description: returns vlan-mapping operationId: getNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcVlanMappingsVlanMapping parameters: - name: configuration-id in: path description: UUID assigned to configuration. required: true style: simple schema: type: string - name: forwarder-evc-id in: path description: Key for forwarder-evc object required: true style: simple schema: type: string - name: vlan-mapping-id in: path description: Key for vlan-mapping object. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan-mapping1' - description: >- vlan-mapping object is an optional child object of the forwarder-evc object. A given forwarder-evc object may have multiple vlan-mapping objects. ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcVlanMappingsVlanMapping description: > Create or update an existing vlan-mapping. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcVlanMappingsVlanMapping parameters: - name: configuration-id in: path description: UUID assigned to configuration. required: true style: simple schema: type: string - name: forwarder-evc-id in: path description: Key for forwarder-evc object required: true style: simple schema: type: string - name: vlan-mapping-id in: path description: Key for vlan-mapping object. required: true style: simple schema: type: string requestBody: description: vlan-mapping object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkConfigurationsConfigurationForwarderEvcsForwarderEvcVlanMappingsVlanMapping.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan-mapping' - description: vlan-mapping object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkConfigurationsConfigurationForwarderEvcsForwarderEvcVlanMappingsVlanMapping.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcVlanMappingsVlanMapping description: > Update an existing vlan-mapping # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcVlanMappingsVlanMapping parameters: - name: configuration-id in: path description: UUID assigned to configuration. required: true style: simple schema: type: string - name: forwarder-evc-id in: path description: Key for forwarder-evc object required: true style: simple schema: type: string - name: vlan-mapping-id in: path description: Key for vlan-mapping object. required: true style: simple schema: type: string requestBody: description: vlan-mapping object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan-mapping2' - description: vlan-mapping object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcVlanMappingsVlanMapping description: delete an existing vlan-mapping operationId: deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcVlanMappingsVlanMapping parameters: - name: configuration-id in: path description: UUID assigned to configuration. required: true style: simple schema: type: string - name: forwarder-evc-id in: path description: Key for forwarder-evc object required: true style: simple schema: type: string - name: vlan-mapping-id in: path description: Key for vlan-mapping object. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/vlan-mappings: get: tags: - Network summary: getNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcVlanMappings description: returns vlan-mappings operationId: getNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcVlanMappings parameters: - name: configuration-id in: path description: UUID assigned to configuration. required: true style: simple schema: type: string - name: forwarder-evc-id in: path description: Key for forwarder-evc object required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan-mappings1' - description: Collection of vlan mappings. default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/relationship-list/relationship : put: tags: - Network summary: createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcRelationshipListRelationship parameters: - name: configuration-id in: path description: UUID assigned to configuration. required: true style: simple schema: type: string - name: forwarder-evc-id in: path description: Key for forwarder-evc object required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkConfigurationsConfigurationForwarderEvcsForwarderEvc.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkConfigurationsConfigurationForwarderEvcsForwarderEvc.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcRelationshipListRelationship parameters: - name: configuration-id in: path description: UUID assigned to configuration. required: true style: simple schema: type: string - name: forwarder-evc-id in: path description: Key for forwarder-evc object required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}: get: tags: - Network summary: getNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc description: returns forwarder-evc operationId: getNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc parameters: - name: configuration-id in: path description: UUID assigned to configuration. required: true style: simple schema: type: string - name: forwarder-evc-id in: path description: Key for forwarder-evc object required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/forwarder-evc1' - description: >- forwarder object is an optional child object of the Configuration object. ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc description: > Create or update an existing forwarder-evc. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc parameters: - name: configuration-id in: path description: UUID assigned to configuration. required: true style: simple schema: type: string - name: forwarder-evc-id in: path description: Key for forwarder-evc object required: true style: simple schema: type: string requestBody: description: forwarder-evc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkConfigurationsConfigurationForwarderEvcsForwarderEvc.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/forwarder-evc' - description: forwarder-evc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkConfigurationsConfigurationForwarderEvcsForwarderEvc.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc description: > Update an existing forwarder-evc # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc parameters: - name: configuration-id in: path description: UUID assigned to configuration. required: true style: simple schema: type: string - name: forwarder-evc-id in: path description: Key for forwarder-evc object required: true style: simple schema: type: string requestBody: description: forwarder-evc object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/forwarder-evc2' - description: forwarder-evc object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc description: delete an existing forwarder-evc operationId: deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc parameters: - name: configuration-id in: path description: UUID assigned to configuration. required: true style: simple schema: type: string - name: forwarder-evc-id in: path description: Key for forwarder-evc object required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/configurations/configuration/{configuration-id}/forwarder-evcs: get: tags: - Network summary: getNetworkConfigurationsConfigurationForwarderEvcs description: returns forwarder-evcs operationId: getNetworkConfigurationsConfigurationForwarderEvcs parameters: - name: configuration-id in: path description: UUID assigned to configuration. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/forwarder-evcs1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkConfigurationsConfigurationEvcsEvcRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkConfigurationsConfigurationEvcsEvcRelationshipListRelationship parameters: - name: configuration-id in: path description: UUID assigned to configuration. required: true style: simple schema: type: string - name: evc-id in: path description: Unique/key field for the evc object required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkConfigurationsConfigurationEvcsEvc.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkConfigurationsConfigurationEvcsEvc.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkConfigurationsConfigurationEvcsEvcRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkConfigurationsConfigurationEvcsEvcRelationshipListRelationship parameters: - name: configuration-id in: path description: UUID assigned to configuration. required: true style: simple schema: type: string - name: evc-id in: path description: Unique/key field for the evc object required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}: get: tags: - Network summary: getNetworkConfigurationsConfigurationEvcsEvc description: returns evc operationId: getNetworkConfigurationsConfigurationEvcsEvc parameters: - name: configuration-id in: path description: UUID assigned to configuration. required: true style: simple schema: type: string - name: evc-id in: path description: Unique/key field for the evc object required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/evc1' - description: >- evc object is an optional child object of the Configuration object. ###### Related Nodes - TO configuration (PARENT of evc, evc BelongsTo configuration, ONE2ONE)(4) -(4) IF this TO node is deleted, this EVC is DELETED also default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkConfigurationsConfigurationEvcsEvc description: > Create or update an existing evc. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkConfigurationsConfigurationEvcsEvc parameters: - name: configuration-id in: path description: UUID assigned to configuration. required: true style: simple schema: type: string - name: evc-id in: path description: Unique/key field for the evc object required: true style: simple schema: type: string requestBody: description: evc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkConfigurationsConfigurationEvcsEvc.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/evc' - description: evc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkConfigurationsConfigurationEvcsEvc.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkConfigurationsConfigurationEvcsEvc description: > Update an existing evc # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkConfigurationsConfigurationEvcsEvc parameters: - name: configuration-id in: path description: UUID assigned to configuration. required: true style: simple schema: type: string - name: evc-id in: path description: Unique/key field for the evc object required: true style: simple schema: type: string requestBody: description: evc object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/evc2' - description: evc object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkConfigurationsConfigurationEvcsEvc description: delete an existing evc operationId: deleteNetworkConfigurationsConfigurationEvcsEvc parameters: - name: configuration-id in: path description: UUID assigned to configuration. required: true style: simple schema: type: string - name: evc-id in: path description: Unique/key field for the evc object required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/configurations/configuration/{configuration-id}/evcs: get: tags: - Network summary: getNetworkConfigurationsConfigurationEvcs description: returns evcs operationId: getNetworkConfigurationsConfigurationEvcs parameters: - name: configuration-id in: path description: UUID assigned to configuration. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/evcs1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/configurations/configuration/{configuration-id}: get: tags: - Network summary: getNetworkConfigurationsConfiguration description: returns configuration operationId: getNetworkConfigurationsConfiguration parameters: - name: configuration-id in: path description: UUID assigned to configuration. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/configuration1' - description: >- Generic configuration object. ###### Related Nodes - 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, MANY2MANY) - 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) - TO vrf( configuration Uses vrf, ONE2MANY) A Configuration uses VRFs - FROM configuration( configuration BindsTo configuration, ONE2ONE) - FROM evc (CHILD of configuration, evc BelongsTo configuration, ONE2ONE)(1) - FROM forwarder( forwarder Uses configuration, ONE2ONE)(3) - FROM forwarder-evc (CHILD of configuration, forwarder-evc BelongsTo configuration, ONE2ONE)(1) - FROM forwarding-path( forwarding-path Uses configuration, ONE2ONE)(3) - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3) - FROM metadatum (CHILD of configuration, metadatum BelongsTo configuration, MANY2ONE)(1) - FROM service-instance( service-instance Uses configuration, ONE2MANY) - FROM service-instance( service-instance ComposedOf configuration, MANY2MANY) -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also -(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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkConfigurationsConfiguration description: > Create or update an existing configuration. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkConfigurationsConfiguration parameters: - name: configuration-id in: path description: UUID assigned to configuration. required: true style: simple schema: type: string requestBody: description: configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkConfigurationsConfiguration.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/configuration' - description: configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkConfigurationsConfiguration.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkConfigurationsConfiguration description: > Update an existing configuration # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkConfigurationsConfiguration parameters: - name: configuration-id in: path description: UUID assigned to configuration. required: true style: simple schema: type: string requestBody: description: configuration object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/configuration2' - description: configuration object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkConfigurationsConfiguration description: delete an existing configuration operationId: deleteNetworkConfigurationsConfiguration parameters: - name: configuration-id in: path description: UUID assigned to configuration. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/configurations: get: tags: - Network summary: getNetworkConfigurations description: returns configurations operationId: getNetworkConfigurations parameters: - name: configuration-id in: query description: '' style: form explode: true schema: type: string - name: model-invariant-id in: query description: '' style: form explode: true schema: type: string - name: model-version-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/configurations1' - description: Collection of configurations default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/forwarding-paths/forwarding-path/{forwarding-path-id}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkForwardingPathsForwardingPathRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkForwardingPathsForwardingPathRelationshipListRelationship parameters: - name: forwarding-path-id in: path description: Unique ID of this FP required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkForwardingPathsForwardingPath.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkForwardingPathsForwardingPath.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkForwardingPathsForwardingPathRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkForwardingPathsForwardingPathRelationshipListRelationship parameters: - name: forwarding-path-id in: path description: Unique ID of this FP required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkForwardingPathsForwardingPathForwardersForwarderRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkForwardingPathsForwardingPathForwardersForwarderRelationshipListRelationship parameters: - name: forwarding-path-id in: path description: Unique ID of this FP required: true style: simple schema: type: string - name: sequence in: path description: Unique ID of this segmentation required: true style: simple schema: type: integer format: int32 requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkForwardingPathsForwardingPathForwardersForwarder.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkForwardingPathsForwardingPathForwardersForwarder.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkForwardingPathsForwardingPathForwardersForwarderRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkForwardingPathsForwardingPathForwardersForwarderRelationshipListRelationship parameters: - name: forwarding-path-id in: path description: Unique ID of this FP required: true style: simple schema: type: string - name: sequence in: path description: Unique ID of this segmentation required: true style: simple schema: type: integer format: int32 responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}: get: tags: - Network summary: getNetworkForwardingPathsForwardingPathForwardersForwarder description: returns forwarder operationId: getNetworkForwardingPathsForwardingPathForwardersForwarder parameters: - name: forwarding-path-id in: path description: Unique ID of this FP required: true style: simple schema: type: string - name: sequence in: path description: Unique ID of this segmentation required: true style: simple schema: type: integer format: int32 responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/forwarder1' - description: >- Entity describing a sequenced segment of forwarding path ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkForwardingPathsForwardingPathForwardersForwarder description: > Create or update an existing forwarder. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkForwardingPathsForwardingPathForwardersForwarder parameters: - name: forwarding-path-id in: path description: Unique ID of this FP required: true style: simple schema: type: string - name: sequence in: path description: Unique ID of this segmentation required: true style: simple schema: type: integer format: int32 requestBody: description: forwarder object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkForwardingPathsForwardingPathForwardersForwarder.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/forwarder' - description: forwarder object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkForwardingPathsForwardingPathForwardersForwarder.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkForwardingPathsForwardingPathForwardersForwarder description: > Update an existing forwarder # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkForwardingPathsForwardingPathForwardersForwarder parameters: - name: forwarding-path-id in: path description: Unique ID of this FP required: true style: simple schema: type: string - name: sequence in: path description: Unique ID of this segmentation required: true style: simple schema: type: integer format: int32 requestBody: description: forwarder object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/forwarder2' - description: forwarder object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkForwardingPathsForwardingPathForwardersForwarder description: delete an existing forwarder operationId: deleteNetworkForwardingPathsForwardingPathForwardersForwarder parameters: - name: forwarding-path-id in: path description: Unique ID of this FP required: true style: simple schema: type: string - name: sequence in: path description: Unique ID of this segmentation required: true style: simple schema: type: integer format: int32 - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders: get: tags: - Network summary: getNetworkForwardingPathsForwardingPathForwarders description: returns forwarders operationId: getNetworkForwardingPathsForwardingPathForwarders parameters: - name: forwarding-path-id in: path description: Unique ID of this FP required: true style: simple schema: type: string - name: sequence in: query description: '' style: form explode: true schema: type: integer format: int32 responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/forwarders1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/forwarding-paths/forwarding-path/{forwarding-path-id}: get: tags: - Network summary: getNetworkForwardingPathsForwardingPath description: returns forwarding-path operationId: getNetworkForwardingPathsForwardingPath parameters: - name: forwarding-path-id in: path description: Unique ID of this FP required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/forwarding-path1' - description: >- Entity that describes the sequenced forwarding path between interfaces of services or resources ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkForwardingPathsForwardingPath description: > Create or update an existing forwarding-path. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkForwardingPathsForwardingPath parameters: - name: forwarding-path-id in: path description: Unique ID of this FP required: true style: simple schema: type: string requestBody: description: forwarding-path object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkForwardingPathsForwardingPath.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/forwarding-path' - description: forwarding-path object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkForwardingPathsForwardingPath.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkForwardingPathsForwardingPath description: > Update an existing forwarding-path # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkForwardingPathsForwardingPath parameters: - name: forwarding-path-id in: path description: Unique ID of this FP required: true style: simple schema: type: string requestBody: description: forwarding-path object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/forwarding-path2' - description: forwarding-path object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkForwardingPathsForwardingPath description: delete an existing forwarding-path operationId: deleteNetworkForwardingPathsForwardingPath parameters: - name: forwarding-path-id in: path description: Unique ID of this FP required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/forwarding-paths: get: tags: - Network summary: getNetworkForwardingPaths description: returns forwarding-paths operationId: getNetworkForwardingPaths parameters: - name: forwarding-path-id in: query description: '' style: form explode: true schema: type: string - name: forwarding-path-name in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/forwarding-paths1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/collections/collection/{collection-id}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkCollectionsCollectionRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkCollectionsCollectionRelationshipListRelationship parameters: - name: collection-id in: path description: Collection Object UUID required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkCollectionsCollection.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkCollectionsCollection.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkCollectionsCollectionRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkCollectionsCollectionRelationshipListRelationship parameters: - name: collection-id in: path description: Collection Object UUID required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/collections/collection/{collection-id}: get: tags: - Network summary: getNetworkCollectionsCollection description: returns collection operationId: getNetworkCollectionsCollection parameters: - name: collection-id in: path description: Collection Object UUID required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/collection1' - description: >- represents the collection resource in the TOSCA model ###### Related Nodes - FROM instance-group( instance-group BelongsTo collection, ONE2ONE) - FROM service-instance( service-instance ComposedOf collection, ONE2ONE) default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkCollectionsCollection description: > Create or update an existing collection. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkCollectionsCollection parameters: - name: collection-id in: path description: Collection Object UUID required: true style: simple schema: type: string requestBody: description: collection object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkCollectionsCollection.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/collection' - description: collection object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkCollectionsCollection.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkCollectionsCollection description: > Update an existing collection # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkCollectionsCollection parameters: - name: collection-id in: path description: Collection Object UUID required: true style: simple schema: type: string requestBody: description: collection object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/collection2' - description: collection object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkCollectionsCollection description: delete an existing collection operationId: deleteNetworkCollectionsCollection parameters: - name: collection-id in: path description: Collection Object UUID required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/collections: get: tags: - Network summary: getNetworkCollections description: returns collections operationId: getNetworkCollections parameters: - name: collection-id in: query description: '' style: form explode: true schema: type: string - name: model-invariant-id in: query description: '' style: form explode: true schema: type: string - name: model-version-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/collections1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vlan-tags/vlan-tag/{vlan-tag-id}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkVlanTagsVlanTagRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkVlanTagsVlanTagRelationshipListRelationship parameters: - name: vlan-tag-id in: path description: Unique ID of the vlan-tag required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVlanTagsVlanTag.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVlanTagsVlanTag.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVlanTagsVlanTagRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkVlanTagsVlanTagRelationshipListRelationship parameters: - name: vlan-tag-id in: path description: Unique ID of the vlan-tag required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vlan-tags/vlan-tag/{vlan-tag-id}: get: tags: - Network summary: getNetworkVlanTagsVlanTag description: returns vlan-tag operationId: getNetworkVlanTagsVlanTag parameters: - name: vlan-tag-id in: path description: Unique ID of the vlan-tag required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan-tag1' - description: >- ###### Related Nodes - 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) default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkVlanTagsVlanTag description: > Create or update an existing vlan-tag. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkVlanTagsVlanTag parameters: - name: vlan-tag-id in: path description: Unique ID of the vlan-tag required: true style: simple schema: type: string requestBody: description: vlan-tag object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVlanTagsVlanTag.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan-tag' - description: vlan-tag object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkVlanTagsVlanTag.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkVlanTagsVlanTag description: > Update an existing vlan-tag # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkVlanTagsVlanTag parameters: - name: vlan-tag-id in: path description: Unique ID of the vlan-tag required: true style: simple schema: type: string requestBody: description: vlan-tag object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/vlan-tag2' - description: vlan-tag object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkVlanTagsVlanTag description: delete an existing vlan-tag operationId: deleteNetworkVlanTagsVlanTag parameters: - name: vlan-tag-id in: path description: Unique ID of the vlan-tag required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/vlan-tags: get: tags: - Network summary: getNetworkVlanTags description: returns vlan-tags operationId: getNetworkVlanTags parameters: [] responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/vlan-tags1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/connectivities/connectivity/{connectivity-id}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkConnectivitiesConnectivityRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkConnectivitiesConnectivityRelationshipListRelationship parameters: - name: connectivity-id in: path description: Uniquely identifies this connectivity by id required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkConnectivitiesConnectivity.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkConnectivitiesConnectivity.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkConnectivitiesConnectivityRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkConnectivitiesConnectivityRelationshipListRelationship parameters: - name: connectivity-id in: path description: Uniquely identifies this connectivity by id required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/connectivities/connectivity/{connectivity-id}: get: tags: - Network summary: getNetworkConnectivitiesConnectivity description: returns connectivity operationId: getNetworkConnectivitiesConnectivity parameters: - name: connectivity-id in: path description: Uniquely identifies this connectivity by id required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/connectivity1' - description: >- Instance of a connectivity ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkConnectivitiesConnectivity description: > Create or update an existing connectivity. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkConnectivitiesConnectivity parameters: - name: connectivity-id in: path description: Uniquely identifies this connectivity by id required: true style: simple schema: type: string requestBody: description: connectivity object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkConnectivitiesConnectivity.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/connectivity' - description: connectivity object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkConnectivitiesConnectivity.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkConnectivitiesConnectivity description: > Update an existing connectivity # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkConnectivitiesConnectivity parameters: - name: connectivity-id in: path description: Uniquely identifies this connectivity by id required: true style: simple schema: type: string requestBody: description: connectivity object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/connectivity2' - description: connectivity object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkConnectivitiesConnectivity description: delete an existing connectivity operationId: deleteNetworkConnectivitiesConnectivity parameters: - name: connectivity-id in: path description: Uniquely identifies this connectivity by id required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/connectivities: get: tags: - Network summary: getNetworkConnectivities description: returns connectivities operationId: getNetworkConnectivities parameters: - name: connectivity-id in: query description: '' style: form explode: true schema: type: string - name: bandwidth-profile-name in: query description: '' style: form explode: true schema: type: string - name: vpn-type in: query description: '' style: form explode: true schema: type: string - name: color-aware in: query description: '' style: form explode: true schema: type: string - name: coupling-flag in: query description: '' style: form explode: true schema: type: string - name: etht-svc-name in: query description: '' style: form explode: true schema: type: string - name: access-provider-id in: query description: '' style: form explode: true schema: type: string - name: access-client-id in: query description: '' style: form explode: true schema: type: string - name: access-topology-id in: query description: '' style: form explode: true schema: type: string - name: access-node-id in: query description: '' style: form explode: true schema: type: string - name: access-ltp-id in: query description: '' style: form explode: true schema: type: string - name: operational-status in: query description: '' style: form explode: true schema: type: string - name: model-invariant-id in: query description: '' style: form explode: true schema: type: string - name: model-version-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/connectivities1' - description: Collection of connectivities default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false ? /network/lan-port-configs/lan-port-config/{lan-port-config-id}/dhcp-services/dhcp-service/{dhcp-service-id}/relationship-list/relationship : put: tags: - Network summary: createOrUpdateNetworkLanPortConfigsLanPortConfigDhcpServicesDhcpServiceRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkLanPortConfigsLanPortConfigDhcpServicesDhcpServiceRelationshipListRelationship parameters: - name: lan-port-config-id in: path description: Uniquely identifies this lan-port-config by id required: true style: simple schema: type: string - name: dhcp-service-id in: path description: Uniquely identifies this dhcp-service by id required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkLanPortConfigsLanPortConfigDhcpServicesDhcpService.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkLanPortConfigsLanPortConfigDhcpServicesDhcpService.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkLanPortConfigsLanPortConfigDhcpServicesDhcpServiceRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkLanPortConfigsLanPortConfigDhcpServicesDhcpServiceRelationshipListRelationship parameters: - name: lan-port-config-id in: path description: Uniquely identifies this lan-port-config by id required: true style: simple schema: type: string - name: dhcp-service-id in: path description: Uniquely identifies this dhcp-service by id required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/lan-port-configs/lan-port-config/{lan-port-config-id}/dhcp-services/dhcp-service/{dhcp-service-id}: get: tags: - Network summary: getNetworkLanPortConfigsLanPortConfigDhcpServicesDhcpService description: returns dhcp-service operationId: getNetworkLanPortConfigsLanPortConfigDhcpServicesDhcpService parameters: - name: lan-port-config-id in: path description: Uniquely identifies this lan-port-config by id required: true style: simple schema: type: string - name: dhcp-service-id in: path description: Uniquely identifies this dhcp-service by id required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/dhcp-service1' - description: >- Instance of a dhcp-service ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkLanPortConfigsLanPortConfigDhcpServicesDhcpService description: > Create or update an existing dhcp-service. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkLanPortConfigsLanPortConfigDhcpServicesDhcpService parameters: - name: lan-port-config-id in: path description: Uniquely identifies this lan-port-config by id required: true style: simple schema: type: string - name: dhcp-service-id in: path description: Uniquely identifies this dhcp-service by id required: true style: simple schema: type: string requestBody: description: dhcp-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkLanPortConfigsLanPortConfigDhcpServicesDhcpService.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/dhcp-service' - description: dhcp-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkLanPortConfigsLanPortConfigDhcpServicesDhcpService.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkLanPortConfigsLanPortConfigDhcpServicesDhcpService description: > Update an existing dhcp-service # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkLanPortConfigsLanPortConfigDhcpServicesDhcpService parameters: - name: lan-port-config-id in: path description: Uniquely identifies this lan-port-config by id required: true style: simple schema: type: string - name: dhcp-service-id in: path description: Uniquely identifies this dhcp-service by id required: true style: simple schema: type: string requestBody: description: dhcp-service object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/dhcp-service2' - description: dhcp-service object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkLanPortConfigsLanPortConfigDhcpServicesDhcpService description: delete an existing dhcp-service operationId: deleteNetworkLanPortConfigsLanPortConfigDhcpServicesDhcpService parameters: - name: lan-port-config-id in: path description: Uniquely identifies this lan-port-config by id required: true style: simple schema: type: string - name: dhcp-service-id in: path description: Uniquely identifies this dhcp-service by id required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/lan-port-configs/lan-port-config/{lan-port-config-id}/dhcp-services: get: tags: - Network summary: getNetworkLanPortConfigsLanPortConfigDhcpServices description: returns dhcp-services operationId: getNetworkLanPortConfigsLanPortConfigDhcpServices parameters: - name: lan-port-config-id in: path description: Uniquely identifies this lan-port-config by id required: true style: simple schema: type: string - name: dhcp-service-id in: query description: '' style: form explode: true schema: type: string - name: server-ipv4-address in: query description: '' style: form explode: true schema: type: string - name: server-ipv6-address in: query description: '' style: form explode: true schema: type: string - name: dhcp-service-type in: query description: '' style: form explode: true schema: type: string - name: domain-name in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/dhcp-services1' - description: Collection of dhcp-services default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/lan-port-configs/lan-port-config/{lan-port-config-id}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkLanPortConfigsLanPortConfigRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkLanPortConfigsLanPortConfigRelationshipListRelationship parameters: - name: lan-port-config-id in: path description: Uniquely identifies this lan-port-config by id required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkLanPortConfigsLanPortConfig.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkLanPortConfigsLanPortConfig.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkLanPortConfigsLanPortConfigRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkLanPortConfigsLanPortConfigRelationshipListRelationship parameters: - name: lan-port-config-id in: path description: Uniquely identifies this lan-port-config by id required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/lan-port-configs/lan-port-config/{lan-port-config-id}: get: tags: - Network summary: getNetworkLanPortConfigsLanPortConfig description: returns lan-port-config operationId: getNetworkLanPortConfigsLanPortConfig parameters: - name: lan-port-config-id in: path description: Uniquely identifies this lan-port-config by id required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/lan-port-config1' - description: >- Instance of a lan-port-config ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkLanPortConfigsLanPortConfig description: > Create or update an existing lan-port-config. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkLanPortConfigsLanPortConfig parameters: - name: lan-port-config-id in: path description: Uniquely identifies this lan-port-config by id required: true style: simple schema: type: string requestBody: description: lan-port-config object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkLanPortConfigsLanPortConfig.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/lan-port-config' - description: lan-port-config object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkLanPortConfigsLanPortConfig.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkLanPortConfigsLanPortConfig description: > Update an existing lan-port-config # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkLanPortConfigsLanPortConfig parameters: - name: lan-port-config-id in: path description: Uniquely identifies this lan-port-config by id required: true style: simple schema: type: string requestBody: description: lan-port-config object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/lan-port-config2' - description: lan-port-config object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkLanPortConfigsLanPortConfig description: delete an existing lan-port-config operationId: deleteNetworkLanPortConfigsLanPortConfig parameters: - name: lan-port-config-id in: path description: Uniquely identifies this lan-port-config by id required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/lan-port-configs: get: tags: - Network summary: getNetworkLanPortConfigs description: returns lan-port-configs operationId: getNetworkLanPortConfigs parameters: - name: lan-port-config-id in: query description: '' style: form explode: true schema: type: string - name: lan-port-config-name in: query description: '' style: form explode: true schema: type: string - name: device-id in: query description: '' style: form explode: true schema: type: string - name: port-id in: query description: '' style: form explode: true schema: type: string - name: ipv4-address in: query description: '' style: form explode: true schema: type: string - name: ipv6-address in: query description: '' style: form explode: true schema: type: string - name: vlan-tag in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/lan-port-configs1' - description: Collection of lan-port-configs default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/network-resources/network-resource/{network-id}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkNetworkResourcesNetworkResourceRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkNetworkResourcesNetworkResourceRelationshipListRelationship parameters: - name: network-id in: path description: Uniquely identifies this network-resource by id required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNetworkResourcesNetworkResource.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNetworkResourcesNetworkResource.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkNetworkResourcesNetworkResourceRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkNetworkResourcesNetworkResourceRelationshipListRelationship parameters: - name: network-id in: path description: Uniquely identifies this network-resource by id required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/network-resources/network-resource/{network-id}: get: tags: - Network summary: getNetworkNetworkResourcesNetworkResource description: returns network-resource operationId: getNetworkNetworkResourcesNetworkResource parameters: - name: network-id in: path description: Uniquely identifies this network-resource by id required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/network-resource1' - description: >- Instance of a network-resource ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkNetworkResourcesNetworkResource description: > Create or update an existing network-resource. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkNetworkResourcesNetworkResource parameters: - name: network-id in: path description: Uniquely identifies this network-resource by id required: true style: simple schema: type: string requestBody: description: network-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNetworkResourcesNetworkResource.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/network-resource' - description: network-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkNetworkResourcesNetworkResource.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkNetworkResourcesNetworkResource description: > Update an existing network-resource # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkNetworkResourcesNetworkResource parameters: - name: network-id in: path description: Uniquely identifies this network-resource by id required: true style: simple schema: type: string requestBody: description: network-resource object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/network-resource2' - description: network-resource object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkNetworkResourcesNetworkResource description: delete an existing network-resource operationId: deleteNetworkNetworkResourcesNetworkResource parameters: - name: network-id in: path description: Uniquely identifies this network-resource by id required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/network-resources: get: tags: - Network summary: getNetworkNetworkResources description: returns network-resources operationId: getNetworkNetworkResources parameters: - name: network-id in: query description: '' style: form explode: true schema: type: string - name: provider-id in: query description: '' style: form explode: true schema: type: string - name: client-id in: query description: '' style: form explode: true schema: type: string - name: te-topo-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/network-resources1' - description: Collection of network-resources default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/site-resources/site-resource/{site-resource-id}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkSiteResourcesSiteResourceRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkSiteResourcesSiteResourceRelationshipListRelationship parameters: - name: site-resource-id in: path description: Uniquely identifies this site-resource by id required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSiteResourcesSiteResource.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSiteResourcesSiteResource.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkSiteResourcesSiteResourceRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkSiteResourcesSiteResourceRelationshipListRelationship parameters: - name: site-resource-id in: path description: Uniquely identifies this site-resource by id required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/site-resources/site-resource/{site-resource-id}: get: tags: - Network summary: getNetworkSiteResourcesSiteResource description: returns site-resource operationId: getNetworkSiteResourcesSiteResource parameters: - name: site-resource-id in: path description: Uniquely identifies this site-resource by id required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/site-resource1' - description: >- Instance of a site-resource ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkSiteResourcesSiteResource description: > Create or update an existing site-resource. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkSiteResourcesSiteResource parameters: - name: site-resource-id in: path description: Uniquely identifies this site-resource by id required: true style: simple schema: type: string requestBody: description: site-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSiteResourcesSiteResource.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/site-resource' - description: site-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSiteResourcesSiteResource.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkSiteResourcesSiteResource description: > Update an existing site-resource # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkSiteResourcesSiteResource parameters: - name: site-resource-id in: path description: Uniquely identifies this site-resource by id required: true style: simple schema: type: string requestBody: description: site-resource object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/site-resource2' - description: site-resource object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkSiteResourcesSiteResource description: delete an existing site-resource operationId: deleteNetworkSiteResourcesSiteResource parameters: - name: site-resource-id in: path description: Uniquely identifies this site-resource by id required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/site-resources: get: tags: - Network summary: getNetworkSiteResources description: returns site-resources operationId: getNetworkSiteResources parameters: - name: site-resource-id in: query description: '' style: form explode: true schema: type: string - name: site-resource-name in: query description: '' style: form explode: true schema: type: string - name: type in: query description: '' style: form explode: true schema: type: string - name: role in: query description: '' style: form explode: true schema: type: string - name: generated-site-id in: query description: '' style: form explode: true schema: type: string - name: operational-status in: query description: '' style: form explode: true schema: type: string - name: model-invariant-id in: query description: '' style: form explode: true schema: type: string - name: model-version-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/site-resources1' - description: Collection of site-resources default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/sdwan-vpns/sdwan-vpn/{sdwan-vpn-id}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkSdwanVpnsSdwanVpnRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkSdwanVpnsSdwanVpnRelationshipListRelationship parameters: - name: sdwan-vpn-id in: path description: Uniquely identifies this sdwan-vpn by id required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSdwanVpnsSdwanVpn.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSdwanVpnsSdwanVpn.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkSdwanVpnsSdwanVpnRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkSdwanVpnsSdwanVpnRelationshipListRelationship parameters: - name: sdwan-vpn-id in: path description: Uniquely identifies this sdwan-vpn by id required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/sdwan-vpns/sdwan-vpn/{sdwan-vpn-id}: get: tags: - Network summary: getNetworkSdwanVpnsSdwanVpn description: returns sdwan-vpn operationId: getNetworkSdwanVpnsSdwanVpn parameters: - name: sdwan-vpn-id in: path description: Uniquely identifies this sdwan-vpn by id required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sdwan-vpn1' - description: >- Instance of an sdwan-vpn ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkSdwanVpnsSdwanVpn description: > Create or update an existing sdwan-vpn. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkSdwanVpnsSdwanVpn parameters: - name: sdwan-vpn-id in: path description: Uniquely identifies this sdwan-vpn by id required: true style: simple schema: type: string requestBody: description: sdwan-vpn object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSdwanVpnsSdwanVpn.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/sdwan-vpn' - description: sdwan-vpn object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkSdwanVpnsSdwanVpn.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkSdwanVpnsSdwanVpn description: > Update an existing sdwan-vpn # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkSdwanVpnsSdwanVpn parameters: - name: sdwan-vpn-id in: path description: Uniquely identifies this sdwan-vpn by id required: true style: simple schema: type: string requestBody: description: sdwan-vpn object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/sdwan-vpn2' - description: sdwan-vpn object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkSdwanVpnsSdwanVpn description: delete an existing sdwan-vpn operationId: deleteNetworkSdwanVpnsSdwanVpn parameters: - name: sdwan-vpn-id in: path description: Uniquely identifies this sdwan-vpn by id required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/sdwan-vpns: get: tags: - Network summary: getNetworkSdwanVpns description: returns sdwan-vpns operationId: getNetworkSdwanVpns parameters: - name: sdwan-vpn-id in: query description: '' style: form explode: true schema: type: string - name: sdwan-vpn-name in: query description: '' style: form explode: true schema: type: string - name: vxlan-id in: query description: '' style: form explode: true schema: type: string - name: topology in: query description: '' style: form explode: true schema: type: string - name: operational-status in: query description: '' style: form explode: true schema: type: string - name: model-invariant-id in: query description: '' style: form explode: true schema: type: string - name: model-version-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sdwan-vpns1' - description: Collection of sdwan-vpns default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/devices/device/{device-id}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkDevicesDeviceRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkDevicesDeviceRelationshipListRelationship parameters: - name: device-id in: path description: Uniquely identifies this device by id required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkDevicesDevice.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkDevicesDevice.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkDevicesDeviceRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkDevicesDeviceRelationshipListRelationship parameters: - name: device-id in: path description: Uniquely identifies this device by id required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/devices/device/{device-id}: get: tags: - Network summary: getNetworkDevicesDevice description: returns device operationId: getNetworkDevicesDevice parameters: - name: device-id in: path description: Uniquely identifies this device by id required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/device1' - description: >- Instance of a device ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkDevicesDevice description: > Create or update an existing device. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkDevicesDevice parameters: - name: device-id in: path description: Uniquely identifies this device by id required: true style: simple schema: type: string requestBody: description: device object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkDevicesDevice.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/device' - description: device object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkDevicesDevice.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkDevicesDevice description: > Update an existing device # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkDevicesDevice parameters: - name: device-id in: path description: Uniquely identifies this device by id required: true style: simple schema: type: string requestBody: description: device object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/device2' - description: device object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkDevicesDevice description: delete an existing device operationId: deleteNetworkDevicesDevice parameters: - name: device-id in: path description: Uniquely identifies this device by id required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/devices: get: tags: - Network summary: getNetworkDevices description: returns devices operationId: getNetworkDevices parameters: - name: device-id in: query description: '' style: form explode: true schema: type: string - name: esn in: query description: '' style: form explode: true schema: type: string - name: device-name in: query description: '' style: form explode: true schema: type: string - name: vendor in: query description: '' style: form explode: true schema: type: string - name: class in: query description: '' style: form explode: true schema: type: string - name: type in: query description: '' style: form explode: true schema: type: string - name: version in: query description: '' style: form explode: true schema: type: string - name: system-ip in: query description: '' style: form explode: true schema: type: string - name: system-ipv4 in: query description: '' style: form explode: true schema: type: string - name: system-ipv6 in: query description: '' style: form explode: true schema: type: string - name: operational-status in: query description: '' style: form explode: true schema: type: string - name: model-invariant-id in: query description: '' style: form explode: true schema: type: string - name: model-version-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/devices1' - description: Collection of devices default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/wan-port-configs/wan-port-config/{wan-port-config-id}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkWanPortConfigsWanPortConfigRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkWanPortConfigsWanPortConfigRelationshipListRelationship parameters: - name: wan-port-config-id in: path description: Uniquely identifies this wan-port-config by id required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkWanPortConfigsWanPortConfig.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkWanPortConfigsWanPortConfig.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkWanPortConfigsWanPortConfigRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkWanPortConfigsWanPortConfigRelationshipListRelationship parameters: - name: wan-port-config-id in: path description: Uniquely identifies this wan-port-config by id required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/wan-port-configs/wan-port-config/{wan-port-config-id}: get: tags: - Network summary: getNetworkWanPortConfigsWanPortConfig description: returns wan-port-config operationId: getNetworkWanPortConfigsWanPortConfig parameters: - name: wan-port-config-id in: path description: Uniquely identifies this wan-port-config by id required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/wan-port-config1' - description: >- Instance of a wan-port-config ###### Related Nodes - 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, ONE2MANY) For CCVPN Usecase -(2) IF this WAN-PORT-CONFIG node is deleted, this TO node is DELETED also default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkWanPortConfigsWanPortConfig description: > Create or update an existing wan-port-config. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkWanPortConfigsWanPortConfig parameters: - name: wan-port-config-id in: path description: Uniquely identifies this wan-port-config by id required: true style: simple schema: type: string requestBody: description: wan-port-config object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkWanPortConfigsWanPortConfig.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/wan-port-config' - description: wan-port-config object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkWanPortConfigsWanPortConfig.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkWanPortConfigsWanPortConfig description: > Update an existing wan-port-config # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkWanPortConfigsWanPortConfig parameters: - name: wan-port-config-id in: path description: Uniquely identifies this wan-port-config by id required: true style: simple schema: type: string requestBody: description: wan-port-config object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/wan-port-config2' - description: wan-port-config object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkWanPortConfigsWanPortConfig description: delete an existing wan-port-config operationId: deleteNetworkWanPortConfigsWanPortConfig parameters: - name: wan-port-config-id in: path description: Uniquely identifies this wan-port-config by id required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/wan-port-configs: get: tags: - Network summary: getNetworkWanPortConfigs description: returns wan-port-configs operationId: getNetworkWanPortConfigs parameters: - name: wan-port-config-id in: query description: '' style: form explode: true schema: type: string - name: wan-port-config-name in: query description: '' style: form explode: true schema: type: string - name: device-id in: query description: '' style: form explode: true schema: type: string - name: ip-address in: query description: '' style: form explode: true schema: type: string - name: ipv4-address in: query description: '' style: form explode: true schema: type: string - name: ipv6-address in: query description: '' style: form explode: true schema: type: string - name: port-type in: query description: '' style: form explode: true schema: type: string - name: port-number in: query description: '' style: form explode: true schema: type: string - name: device-port-id in: query description: '' style: form explode: true schema: type: string - name: wan-port-id in: query description: '' style: form explode: true schema: type: string - name: operational-status in: query description: '' style: form explode: true schema: type: string - name: model-invariant-id in: query description: '' style: form explode: true schema: type: string - name: model-version-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/wan-port-configs1' - description: Collection of wan-port-configs default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/ext-aai-networks/ext-aai-network/{aai-id}/esr-system-info/{esr-system-info-id}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkExtAaiNetworksExtAaiNetworkEsrSystemInfoRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkExtAaiNetworksExtAaiNetworkEsrSystemInfoRelationshipListRelationship parameters: - name: aai-id in: path description: Unique ID of the referenced AAI. required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkExtAaiNetworksExtAaiNetworkEsrSystemInfo.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkExtAaiNetworksExtAaiNetworkEsrSystemInfo.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkExtAaiNetworksExtAaiNetworkEsrSystemInfoRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkExtAaiNetworksExtAaiNetworkEsrSystemInfoRelationshipListRelationship parameters: - name: aai-id in: path description: Unique ID of the referenced AAI. required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/ext-aai-networks/ext-aai-network/{aai-id}/esr-system-info/{esr-system-info-id}: get: tags: - Network summary: getNetworkExtAaiNetworksExtAaiNetworkEsrSystemInfo description: returns esr-system-info operationId: getNetworkExtAaiNetworksExtAaiNetworkEsrSystemInfo parameters: - name: aai-id in: path description: Unique ID of the referenced AAI. required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/esr-system-info1' - description: >- Persist common address information of external systems. ###### Related Nodes - TO cloud-region (PARENT of esr-system-info, esr-system-info BelongsTo cloud-region, MANY2ONE)(4) - TO esr-ems (PARENT of esr-system-info, esr-system-info BelongsTo esr-ems, MANY2ONE)(4) - TO esr-nfvo (PARENT of esr-system-info, esr-system-info BelongsTo esr-nfvo, ONE2ONE)(4) - TO esr-thirdparty-sdnc (PARENT of esr-system-info, esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4) - TO esr-vnfm (PARENT of esr-system-info, esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4) - FROM ext-aai-network (PARENT of esr-system-info, ext-aai-network Uses esr-system-info, ONE2MANY) For CCVPN Usecase(3) -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also -ESR-SYSTEM-INFO cannot be deleted if related to EXT-AAI-NETWORK default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkExtAaiNetworksExtAaiNetworkEsrSystemInfo description: > Create or update an existing esr-system-info. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkExtAaiNetworksExtAaiNetworkEsrSystemInfo parameters: - name: aai-id in: path description: Unique ID of the referenced AAI. required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string requestBody: description: esr-system-info object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkExtAaiNetworksExtAaiNetworkEsrSystemInfo.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/esr-system-info' - description: esr-system-info object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkExtAaiNetworksExtAaiNetworkEsrSystemInfo.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkExtAaiNetworksExtAaiNetworkEsrSystemInfo description: > Update an existing esr-system-info # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkExtAaiNetworksExtAaiNetworkEsrSystemInfo parameters: - name: aai-id in: path description: Unique ID of the referenced AAI. required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string requestBody: description: esr-system-info object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/esr-system-info2' - description: esr-system-info object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkExtAaiNetworksExtAaiNetworkEsrSystemInfo description: delete an existing esr-system-info operationId: deleteNetworkExtAaiNetworksExtAaiNetworkEsrSystemInfo parameters: - name: aai-id in: path description: Unique ID of the referenced AAI. required: true style: simple schema: type: string - name: esr-system-info-id in: path description: Unique ID of esr system info. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/ext-aai-networks/ext-aai-network/{aai-id}/relationship-list/relationship: put: tags: - Network summary: createOrUpdateNetworkExtAaiNetworksExtAaiNetworkRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateNetworkExtAaiNetworksExtAaiNetworkRelationshipListRelationship parameters: - name: aai-id in: path description: Unique ID of the referenced AAI. required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkExtAaiNetworksExtAaiNetwork.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkExtAaiNetworksExtAaiNetwork.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkExtAaiNetworksExtAaiNetworkRelationshipListRelationship description: delete an existing relationship operationId: deleteNetworkExtAaiNetworksExtAaiNetworkRelationshipListRelationship parameters: - name: aai-id in: path description: Unique ID of the referenced AAI. required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/ext-aai-networks/ext-aai-network/{aai-id}: get: tags: - Network summary: getNetworkExtAaiNetworksExtAaiNetwork description: returns ext-aai-network operationId: getNetworkExtAaiNetworksExtAaiNetwork parameters: - name: aai-id in: path description: Unique ID of the referenced AAI. required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/ext-aai-network1' - description: >- Refer to an external AAI in another ONAP. ###### Related Nodes - 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 default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Network summary: createOrUpdateNetworkExtAaiNetworksExtAaiNetwork description: > Create or update an existing ext-aai-network. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateNetworkExtAaiNetworksExtAaiNetwork parameters: - name: aai-id in: path description: Unique ID of the referenced AAI. required: true style: simple schema: type: string requestBody: description: ext-aai-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkExtAaiNetworksExtAaiNetwork.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/ext-aai-network' - description: ext-aai-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/NetworkExtAaiNetworksExtAaiNetwork.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Network summary: UpdateNetworkExtAaiNetworksExtAaiNetwork description: > Update an existing ext-aai-network # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateNetworkExtAaiNetworksExtAaiNetwork parameters: - name: aai-id in: path description: Unique ID of the referenced AAI. required: true style: simple schema: type: string requestBody: description: ext-aai-network object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/ext-aai-network2' - description: ext-aai-network object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Network summary: deleteNetworkExtAaiNetworksExtAaiNetwork description: delete an existing ext-aai-network operationId: deleteNetworkExtAaiNetworksExtAaiNetwork parameters: - name: aai-id in: path description: Unique ID of the referenced AAI. required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /network/ext-aai-networks: get: tags: - Network summary: getNetworkExtAaiNetworks description: returns ext-aai-networks operationId: getNetworkExtAaiNetworks parameters: - name: aai-id in: query description: '' style: form explode: true schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/ext-aai-networks1' default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /common/contacts/contact/{contact-name}/relationship-list/relationship: put: tags: - Common summary: createOrUpdateCommonContactsContactRelationshipListRelationship description: see node definition for valid relationships operationId: createOrUpdateCommonContactsContactRelationshipListRelationship parameters: - name: contact-name in: path description: Name of the contact required: true style: simple schema: type: string requestBody: description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CommonContactsContact.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/relationship-dict' - description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CommonContactsContact.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Common summary: deleteCommonContactsContactRelationshipListRelationship description: delete an existing relationship operationId: deleteCommonContactsContactRelationshipListRelationship parameters: - name: contact-name in: path description: Name of the contact required: true style: simple schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /common/contacts/contact/{contact-name}: get: tags: - Common summary: getCommonContactsContact description: returns contact operationId: getCommonContactsContact parameters: - name: contact-name in: path description: Name of the contact required: true style: simple schema: type: string responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/contact1' - description: >- Contacts store the vendor information and have a relationship to the generic-vnf. In 1902, this will be populated by SDN-GC ###### Related Nodes - TO generic-vnf( contact supports generic-vnf, MANY2MANY) default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false put: tags: - Common summary: createOrUpdateCommonContactsContact description: > Create or update an existing contact. # Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below operationId: createOrUpdateCommonContactsContact parameters: - name: contact-name in: path description: Name of the contact required: true style: simple schema: type: string requestBody: description: contact object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CommonContactsContact.json) content: application/json: schema: allOf: - $ref: '#/components/schemas/contact' - description: contact object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v16/CommonContactsContact.json) required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false patch: tags: - Common summary: UpdateCommonContactsContact description: > Update an existing contact # Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations. The PUT operation will entirely replace an existing object. The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs. # Other differences between PUT and PATCH are: # - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values. - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent. - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this. operationId: UpdateCommonContactsContact parameters: - name: contact-name in: path description: Name of the contact required: true style: simple schema: type: string requestBody: description: contact object that needs to be updated. content: application/json: schema: allOf: - $ref: '#/components/schemas/contact2' - description: contact object that needs to be updated. required: true responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false delete: tags: - Common summary: deleteCommonContactsContact description: delete an existing contact operationId: deleteCommonContactsContact parameters: - name: contact-name in: path description: Name of the contact required: true style: simple schema: type: string - name: resource-version in: query description: resource-version for concurrency required: true style: form explode: true schema: type: string responses: '200': description: '' headers: {} content: {} default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false /common/contacts: get: tags: - Common summary: getCommonContacts description: returns contacts operationId: getCommonContacts parameters: [] responses: '200': description: successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/contacts1' - description: Collection of contacts default: description: Response codes found in [response codes](https://wiki.web.att.com/pages/viewpage.action?pageId=607391054). headers: {} content: {} deprecated: false components: schemas: action: title: action type: object properties: action-type: type: string action-data: type: array items: $ref: '#/components/schemas/action-data' description: '' action-data: title: action-data type: object properties: property-name: type: string property-value: type: string actions: title: actions type: object properties: update: allOf: - $ref: '#/components/schemas/update' - description: Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team. notify: $ref: '#/components/schemas/notify' description: APIs that are more action related than REST (e.g., notify, update). aggregate-route: title: aggregate-route required: - route-id - network-start-address - cidr-mask - ip-version type: object properties: route-id: type: string description: Unique id of the aggregate-route instance network-start-address: type: string description: Name of the forwarding-path cidr-mask: type: string description: CIDR-mask for aggregate route subnet ip-version: type: string description: Identifies is aggregate route is ipv4 or ipv6 resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: "Aggregate route configs are used on the D2 IPE’s for the Voice services. In 1902, SDNC will create aggregate-route objects and write them to A&AI. \n###### Related Nodes\n- TO l3-network (PARENT of aggregate-route, aggregate-route BelongsTo l3-network, MANY2ONE)(4)\n\n-(4) IF this TO node is deleted, this AGGREGATE-ROUTE is DELETED also" aggregate-routes: title: aggregate-routes type: object properties: aggregate-route: type: array items: $ref: '#/components/schemas/aggregate-route' description: '' description: Collection of aggregate routes. allotted-resource: title: allotted-resource required: - id type: object properties: id: type: string description: Allotted Resource id UUID assigned to this instance. description: type: string description: The descriptive information assigned to this allotted resource instance selflink: type: string description: Link back to more information in the controller model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. resource-version: type: string description: Concurrency value orchestration-status: type: string description: Orchestration status operational-status: type: string description: Indicator for whether the resource is considered operational type: type: string description: Generic description of the type of allotted resource. role: type: string description: role in the network that this resource will be providing. allotted-resource-name: type: string description: Store the name of this allotted-resource. access-provider-id: type: string description: Store the id of the access provider of this allotted-resource. access-client-id: type: string description: Store the id of the access client of this allotted-resource. access-topology-id: type: string description: Store the id of the access topology of this allotted-resource. access-node-id: type: string description: Store the id of the access node of this allotted-resource. access-ltp-id: type: string description: Store the id of the access ltp of this allotted-resource. cvlan: type: string description: Store the cvlan of this allotted-resource. vpn-name: type: string description: Store the vpn-name of this allotted-resource. tunnel-xconnects: type: array items: $ref: '#/components/schemas/tunnel-xconnect' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Represents a slice or partial piece of a resource that gets separately allotted ###### Related Nodes - TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE) AAI-1925 - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY) - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY) - TO l-interface( allotted-resource Uses l-interface, ONE2MANY) - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY) - TO network-policy( allotted-resource Uses network-policy, ONE2ONE) - TO p-interface( allotted-resource Uses p-interface, ONE2MANY) AAI-1925 For CCVPN Usecase - TO service-instance (PARENT of allotted-resource, allotted-resource BelongsTo service-instance, MANY2ONE)(4) - TO vlan( allotted-resource PartOf vlan, MANY2MANY) - TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY) - FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE) AAI-1925 - FROM configuration( configuration Uses allotted-resource, 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 allotted-resources: title: allotted-resources type: object properties: allotted-resource: type: array items: $ref: '#/components/schemas/allotted-resource' description: '' description: This object is used to store slices of services being offered availability-zone: title: availability-zone required: - availability-zone-name - hypervisor-type type: object properties: availability-zone-name: type: string description: Name of the availability zone. Unique across a cloud region hypervisor-type: type: string description: Type of hypervisor. Source of truth should define valid values. operational-status: type: string description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Availability zone, a collection of compute hosts/pservers ###### Related Nodes - 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-zones: title: availability-zones type: object properties: availability-zone: type: array items: $ref: '#/components/schemas/availability-zone' description: '' description: Collection of availability zones az-and-dvs-switches: title: az-and-dvs-switches type: object properties: dvs-switches: allOf: - $ref: '#/components/schemas/dvs-switches' - description: Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs. availability-zone: allOf: - $ref: '#/components/schemas/availability-zone' - description: >- Availability zone, a collection of compute hosts/pservers ###### Related Nodes - 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 business: title: business type: object properties: connectors: type: array items: $ref: '#/components/schemas/connector' description: '' customers: type: array items: $ref: '#/components/schemas/customer' description: '' lines-of-business: type: array items: $ref: '#/components/schemas/line-of-business' description: '' owning-entities: type: array items: $ref: '#/components/schemas/owning-entity' description: '' platforms: type: array items: $ref: '#/components/schemas/platform' description: '' projects: type: array items: $ref: '#/components/schemas/project' description: '' sp-partners: type: array items: $ref: '#/components/schemas/sp-partner' description: '' description: Namespace for business related constructs class-of-service: title: class-of-service required: - cos type: object properties: cos: type: string description: unique identifier of probe probe-id: type: string description: identifier of probe probe-type: type: string description: type of probe resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- ###### Related Nodes - 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 classes-of-service: title: classes-of-service type: object properties: class-of-service: type: array items: $ref: '#/components/schemas/class-of-service' description: '' description: class-of-service of probe cloud-infrastructure: title: cloud-infrastructure type: object properties: complexes: type: array items: $ref: '#/components/schemas/complex' description: '' cloud-regions: type: array items: $ref: '#/components/schemas/cloud-region' description: '' network-profiles: type: array items: $ref: '#/components/schemas/network-profile' description: '' pservers: type: array items: $ref: '#/components/schemas/pserver' description: '' virtual-data-centers: type: array items: $ref: '#/components/schemas/virtual-data-center' description: '' operational-environments: type: array items: $ref: '#/components/schemas/operational-environment' description: '' network-technologies: type: array items: $ref: '#/components/schemas/network-technology' description: '' description: Namespace for cloud infrastructure. cloud-region: title: cloud-region required: - cloud-owner - cloud-region-id - orchestration-disabled - in-maint type: object properties: cloud-owner: type: string description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname cloud-region-id: type: string description: Identifier used by the vendor for the region. Second part of composite key cloud-type: type: string description: Type of the cloud (e.g., openstack) owner-defined-type: type: string description: Cloud-owner defined type indicator (e.g., dcp, lcp) cloud-region-version: type: string description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE. identity-url: type: string description: URL of the keystone identity service cloud-zone: type: string description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. complex-name: type: string description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. sriov-automation: type: string description: Whether the cloud region supports (true) or does not support (false) SR-IOV automation. cloud-extra-info: type: string description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM. upgrade-cycle: type: string description: Upgrade cycle for the cloud region. For AIC regions upgrade cycle is designated by A,B,C etc. orchestration-disabled: type: boolean description: Used to indicate whether orchestration is enabled for this cloud-region. in-maint: type: boolean description: Used to indicate whether or not cloud-region object is in maintenance mode. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. volume-groups: type: array items: $ref: '#/components/schemas/volume-group' description: '' tenants: type: array items: $ref: '#/components/schemas/tenant' description: '' flavors: type: array items: $ref: '#/components/schemas/flavor' description: '' group-assignments: type: array items: $ref: '#/components/schemas/group-assignment' description: '' snapshots: type: array items: $ref: '#/components/schemas/snapshot' description: '' images: type: array items: $ref: '#/components/schemas/image' description: '' dvs-switches: type: array items: $ref: '#/components/schemas/dvs-switch' description: '' oam-networks: type: array items: $ref: '#/components/schemas/oam-network' description: '' availability-zones: type: array items: $ref: '#/components/schemas/availability-zone' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' vip-ipv4-address-list: type: array items: $ref: '#/components/schemas/vip-ipv4-address-list' description: '' vip-ipv6-address-list: type: array items: $ref: '#/components/schemas/vip-ipv6-address-list' description: '' hpa-capabilities: type: array items: $ref: '#/components/schemas/hpa-capability' description: List of cloud-region specific HPA Capabilities esr-system-info-list: type: array items: $ref: '#/components/schemas/esr-system-info' description: '' description: >- 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. ###### Related Nodes - 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 generic-vnf( generic-vnf LocatedIn 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-regions: title: cloud-regions type: object properties: cloud-region: type: array items: $ref: '#/components/schemas/cloud-region' description: '' collection: title: collection required: - collection-id type: object properties: collection-id: type: string description: Collection Object UUID model-invariant-id: type: string description: ASDC model id for this resource or service model model-version-id: type: string description: Model Version collection-name: type: string description: collection name collection-type: type: string description: Collection type collection-role: type: string description: Collection Role collection-function: type: string description: Collection function orchestration-status: type: string description: orchestration status collection-customization-id: type: string description: Captures the id of all the configuration used to customize the resource for the service relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. description: >- represents the collection resource in the TOSCA model ###### Related Nodes - FROM instance-group( instance-group BelongsTo collection, ONE2ONE) - FROM service-instance( service-instance ComposedOf collection, ONE2ONE) collections: title: collections type: object properties: collection: type: array items: $ref: '#/components/schemas/collection' description: '' common: title: common type: object properties: contacts: type: array items: $ref: '#/components/schemas/contact' description: '' description: Namespace for common inventory resources. complex: title: complex required: - physical-location-id - physical-location-type - street1 - city - postal-code - country - region type: object properties: physical-location-id: type: string description: Unique identifier for physical location, e.g., CLLI data-center-code: type: string description: Data center code which can be an alternate way to identify a complex complex-name: type: string description: Gamma complex name for LCP instance. identity-url: type: string description: URL of the keystone identity service resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. physical-location-type: type: string description: Type, e.g., central office, data center. street1: type: string street2: type: string city: type: string state: type: string postal-code: type: string country: type: string region: type: string latitude: type: string longitude: type: string elevation: type: string lata: type: string ctag-pools: type: array items: $ref: '#/components/schemas/ctag-pool' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Collection of physical locations that can house cloud-regions. ###### Related Nodes - 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 complexes: title: complexes type: object properties: complex: type: array items: $ref: '#/components/schemas/complex' description: '' description: Collection of physical locations that can house cloud-regions. configuration: title: configuration required: - configuration-id - configuration-type type: object properties: configuration-id: type: string description: UUID assigned to configuration. management-option: type: string description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well. configuration-name: type: string description: Name of the configuration. configuration-type: type: string description: port-mirroring-configuration. configuration-sub-type: type: string description: vprobe, pprobe. model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. orchestration-status: type: string description: Orchestration status of the configuration. operational-status: type: string description: Indicator for whether the resource is considered operational. configuration-selflink: type: string description: URL to endpoint where AAI can get more details from SDN-GC. model-customization-id: type: string description: id of the configuration used to customize the resource tunnel-bandwidth: type: string description: DHV Site Effective Bandwidth vendor-allowed-max-bandwidth: type: string description: Velocloud Nominal Throughput - VNT config-policy-name: type: string description: 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: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' metadata: type: array items: $ref: '#/components/schemas/metadatum' description: '' forwarder-evcs: type: array items: $ref: '#/components/schemas/forwarder-evc' description: '' evcs: type: array items: $ref: '#/components/schemas/evc' description: '' description: >- Generic configuration object. ###### Related Nodes - 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, MANY2MANY) - 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) - TO vrf( configuration Uses vrf, ONE2MANY) A Configuration uses VRFs - FROM configuration( configuration BindsTo configuration, ONE2ONE) - FROM evc (CHILD of configuration, evc BelongsTo configuration, ONE2ONE)(1) - FROM forwarder( forwarder Uses configuration, ONE2ONE)(3) - FROM forwarder-evc (CHILD of configuration, forwarder-evc BelongsTo configuration, ONE2ONE)(1) - FROM forwarding-path( forwarding-path Uses configuration, ONE2ONE)(3) - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3) - FROM metadatum (CHILD of configuration, metadatum BelongsTo configuration, MANY2ONE)(1) - FROM service-instance( service-instance Uses configuration, ONE2MANY) - FROM service-instance( service-instance ComposedOf configuration, MANY2MANY) -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also -(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 configurations: title: configurations type: object properties: configuration: type: array items: $ref: '#/components/schemas/configuration' description: '' description: Collection of configurations connectivities: title: connectivities type: object properties: connectivity: type: array items: $ref: '#/components/schemas/connectivity' description: '' description: Collection of connectivities connectivity: title: connectivity required: - connectivity-id type: object properties: connectivity-id: type: string description: Uniquely identifies this connectivity by id bandwidth-profile-name: type: string description: Store the name of a bandwidth profile. vpn-type: type: string description: Store the type of a bandwidth profile. cir: type: string description: Store the CIR of this connectivity. eir: type: string description: Store the EIR of this connectivity. cbs: type: string description: Store the CBS of this connectivity. ebs: type: string description: Store the EBS of this connectivity. color-aware: type: string description: Store the color-awareness of this connectivity. coupling-flag: type: string description: Store the coupling flag of this connectivity. etht-svc-name: type: string description: The ethernet service name for this connectivity. access-provider-id: type: string description: Store the id of the access provider of this connectivity. access-client-id: type: string description: Store the id of the access client of this connectivity. access-topology-id: type: string description: Store the id of the access topology of this connectivity. access-node-id: type: string description: Store the id of the access node of this connectivity. access-ltp-id: type: string description: Store the id of the access ltp of this connectivity. connectivity-selflink: type: string description: Store the link to get more information for this connectivity. cvlan: type: string description: Store the cvlan for this connectivity. operational-status: type: string description: Store the operational-status for this object. model-customization-id: type: string description: Store the model-customization-id for this object. model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Instance of a connectivity ###### Related Nodes - 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 connector: title: connector required: - resource-instance-id type: object properties: resource-instance-id: type: string description: Unique id of resource instance. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. widget-model-id: type: string description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. widget-model-version: type: string description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' metadata: type: array items: $ref: '#/components/schemas/metadatum' description: '' description: >- Collection of resource instances used to connect a variety of disparate inventory widgets ###### Related Nodes - 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 connectors: title: connectors type: object properties: connector: type: array items: $ref: '#/components/schemas/connector' description: '' description: Collection of resource instances used to connect a variety of disparate inventory widgets constrained-element-set: title: constrained-element-set required: - constrained-element-set-uuid - constraint-type - check-type type: object properties: constrained-element-set-uuid: type: string constraint-type: type: string check-type: type: string resource-version: type: string element-choice-sets: type: array items: $ref: '#/components/schemas/element-choice-set' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- This is how we would capture constraints defining allowed sets of elements. ###### Related Nodes - 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-sets: title: constrained-element-sets type: object properties: constrained-element-set: type: array items: $ref: '#/components/schemas/constrained-element-set' description: '' contact: title: contact required: - contact-name type: object properties: contact-name: type: string description: Name of the contact contact-telephone: type: string description: Tel no. of contact contact-email: type: string description: e-mail of contact vendor-type: type: string description: NI (Network Integrator)SI (System Integrator) 3rd Party LCM resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Contacts store the vendor information and have a relationship to the generic-vnf. In 1902, this will be populated by SDN-GC ###### Related Nodes - TO generic-vnf( contact supports generic-vnf, MANY2MANY) contacts: title: contacts type: object properties: contact: type: array items: $ref: '#/components/schemas/contact' description: '' description: Collection of contacts cp: title: cp required: - cp-instance-id type: object properties: cp-instance-id: type: string description: Unique ID of the connection point. port-id: type: integer description: port index to represent multiple CPs on VNFC connected to same network. format: int32 resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' l3-interface-ipv4-address-list: type: array items: $ref: '#/components/schemas/l3-interface-ipv4-address-list' description: '' l3-interface-ipv6-address-list: type: array items: $ref: '#/components/schemas/l3-interface-ipv6-address-list' description: '' description: >- point of attachment from services or resources to a virtual link or network. ###### Related Nodes - FROM l-interface( l-interface LinksTo cp, ONE2ONE) - FROM l3-interface-ipv4-address-list (CHILD of cp, l3-interface-ipv4-address-list BelongsTo cp, MANY2ONE)(1) - FROM l3-interface-ipv6-address-list (CHILD of cp, l3-interface-ipv6-address-list BelongsTo cp, MANY2ONE)(1) - FROM l3-network( l3-network LinksTo cp, MANY2MANY) - FROM metadatum( metadatum AppliesTo cp, MANY2MANY) AAI-2154 For BBS Usecase - FROM vip-ipv4-address-list( vip-ipv4-address-list Uses cp, MANY2MANY) - FROM vip-ipv6-address-list( vip-ipv6-address-list Uses cp, MANY2MANY) - FROM vlan-tag( vlan-tag Uses cp, MANY2MANY) - FROM vnfc (PARENT of cp, vnfc BelongsTo cp, ONE2MANY) cp is child of vnfc(3) -(1) IF this CP node is deleted, this FROM node is DELETED also -(3) IF this FROM node is deleted, this CP is DELETED also cps: title: cps type: object properties: cp: type: array items: $ref: '#/components/schemas/cp' description: '' description: Collection of connection points. ctag-assignment: title: ctag-assignment required: - vlan-id-inner type: object properties: vlan-id-inner: type: integer description: id. format: int64 resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- ###### Related Nodes - 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 ctag-assignments: title: ctag-assignments type: object properties: ctag-assignment: type: array items: $ref: '#/components/schemas/ctag-assignment' description: '' ctag-pool: title: ctag-pool required: - target-pe - availability-zone-name - ctag-pool-purpose type: object properties: target-pe: type: string description: The Target provider edge router availability-zone-name: type: string description: Name of the availability zone ctag-pool-purpose: type: string description: Describes what the intended purpose of this pool is. ctag-values: type: string description: Comma separated list of ctags resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- A collection of C tags (vlan tags) grouped for a specific purpose. ###### Related Nodes - 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 ctag-pools: title: ctag-pools type: object properties: ctag-pool: type: array items: $ref: '#/components/schemas/ctag-pool' description: '' customer: title: customer required: - global-customer-id - subscriber-name - subscriber-type type: object properties: global-customer-id: type: string description: Global customer id used across ONAP to uniquely identify customer. subscriber-name: type: string description: Subscriber name, an alternate way to retrieve a customer. subscriber-type: type: string description: Subscriber type, a way to provide VID with only the INFRA customers. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. service-subscriptions: type: array items: $ref: '#/components/schemas/service-subscription' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- customer identifiers to provide linkage back to BSS information. ###### Related Nodes - 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 customers: title: customers type: object properties: customer: type: array items: $ref: '#/components/schemas/customer' description: '' description: Collection of customer identifiers to provide linkage back to BSS information. cvlan-tag-entry: title: cvlan-tag-entry required: - cvlan-tag type: object properties: cvlan-tag: type: integer description: See mis-na-virtualization-platform.yang format: int64 resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' cvlan-tags: title: cvlan-tags type: object properties: cvlan-tag-entry: type: array items: $ref: '#/components/schemas/cvlan-tag-entry' description: '' device: title: device required: - device-id type: object properties: device-id: type: string description: Uniquely identifies this device by id esn: type: string description: Store the esn of this device. device-name: type: string description: Store the name of this device. description: type: string description: Store the description of this device. vendor: type: string description: Store the vendor of this device. class: type: string description: Store the class of this device. type: type: string description: Store the type of this device. version: type: string description: Store the version of this device. system-ip: type: string description: Store the system-ip of this device. system-ipv4: type: string description: Store the system-ipv4 of this device. system-ipv6: type: string description: Store the system-ipv6 of this device. selflink: type: string description: Store the link to get more information for this object. operational-status: type: string description: Store the operational-status for this object. model-customization-id: type: string description: Store the model-customization-id for this object. model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Instance of a device ###### Related Nodes - 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 devices: title: devices type: object properties: device: type: array items: $ref: '#/components/schemas/device' description: '' description: Collection of devices dhcp-service: title: dhcp-service required: - dhcp-service-id type: object properties: dhcp-service-id: type: string description: Uniquely identifies this dhcp-service by id server-ipv4-address: type: string description: Store the server-ip4-address of this dhcp-service. server-ipv6-address: type: string description: Store the server-ipv6-address of this dhcp-service. service-enable: type: string description: Store the service-enable of this dhcp-service. dhcp-service-type: type: string description: Store the dhcp-service-type of this dhcp-service. lease-time: type: string description: Store the lease-time of this dhcp-service. domain-name: type: string description: Store the domain-name of this dhcp-service. dns: type: string description: Store the dns of this dhcp-service. ntp-primary: type: string description: Store the ntp-primary of this dhcp-service. ntp-secondary: type: string description: Store the ntp-secondary of this dhcp-service. nbns: type: string description: Store the nbns of this dhcp-service. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Instance of a dhcp-service ###### Related Nodes - 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-services: title: dhcp-services type: object properties: dhcp-service: type: array items: $ref: '#/components/schemas/dhcp-service' description: '' description: Collection of dhcp-services dvs-switch: title: dvs-switch required: - switch-name - vcenter-url type: object properties: switch-name: type: string description: DVS switch name vcenter-url: type: string description: URL used to reach the vcenter resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: "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. \n###### Related Nodes\n- TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)\n- TO cloud-region (PARENT of dvs-switch, dvs-switch BelongsTo cloud-region, MANY2ONE)" dvs-switches: title: dvs-switches type: object properties: dvs-switch: type: array items: $ref: '#/components/schemas/dvs-switch' description: '' description: Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs. edge-prop-names: title: edge-prop-names type: object properties: edgeLabel: type: string direction: type: string multiplicityRule: type: string contains-other-v: type: string delete-other-v: type: string SVC-INFRA: type: string prevent-delete: type: string aai-uuid: type: string description: Internal map to define the properties of an edge and interpret the map EdgeRules edge-tag-query-request: title: edge-tag-query-request type: object properties: edge-tag: type: string result-detail: type: string start-node-type: type: string start-node-filter: type: array items: $ref: '#/components/schemas/start-node-filter' description: '' include-node-filter: type: array items: $ref: '#/components/schemas/include-node-filter' description: '' secondary-filter: type: array items: $ref: '#/components/schemas/secondary-filter' description: '' edge-tag-query-result: title: edge-tag-query-result type: object properties: tagged-inventory-item-list: type: array items: $ref: '#/components/schemas/tagged-inventory-item-list' description: '' element-choice-set: title: element-choice-set required: - element-choice-set-uuid - element-choice-set-name type: object properties: element-choice-set-uuid: type: string element-choice-set-name: type: string cardinality: type: string resource-version: type: string model-elements: type: array items: $ref: '#/components/schemas/model-element' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- This is how we would capture constraints defining allowed sets of elements. ###### Related Nodes - 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-sets: title: element-choice-sets type: object properties: element-choice-set: type: array items: $ref: '#/components/schemas/element-choice-set' description: '' entitlement: title: entitlement required: - group-uuid - resource-uuid type: object properties: group-uuid: type: string description: Unique ID for the entitlement group the resource comes from, should be uuid. resource-uuid: type: string description: Unique ID of an entitlement resource. resource-version: type: string description: Concurrency value relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Metadata for entitlement group. ###### Related Nodes - 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 entitlements: title: entitlements type: object properties: entitlement: type: array items: $ref: '#/components/schemas/entitlement' description: '' description: Entitlements, keyed by group-uuid and resource-uuid, related to license management esr-ems: title: esr-ems required: - ems-id type: object properties: ems-id: type: string description: Unique ID of EMS. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. esr-system-info-list: type: array items: $ref: '#/components/schemas/esr-system-info' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Persist EMS address information used by EMS driver. ###### Related Nodes - 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 esr-ems-list: title: esr-ems-list type: object properties: esr-ems: type: array items: $ref: '#/components/schemas/esr-ems' description: '' esr-nfvo: title: esr-nfvo required: - nfvo-id type: object properties: nfvo-id: type: string description: Unique ID of nfvo. api-root: type: string description: indecate the api-root. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. esr-system-info-list: type: array items: $ref: '#/components/schemas/esr-system-info' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Persist NFVO address information used by VF-C. ###### Related Nodes - FROM esr-system-info (CHILD of esr-nfvo, esr-system-info BelongsTo esr-nfvo, ONE2ONE)(1) -(1) IF this ESR-NFVO node is deleted, this FROM node is DELETED also esr-nfvo-list: title: esr-nfvo-list type: object properties: esr-nfvo: type: array items: $ref: '#/components/schemas/esr-nfvo' description: '' esr-system-info: title: esr-system-info required: - esr-system-info-id - user-name - password - system-type type: object properties: esr-system-info-id: type: string description: Unique ID of esr system info. system-name: type: string description: name of external system. type: type: string description: type of external systems. vendor: type: string description: vendor of external systems. version: type: string description: version of external systems. service-url: type: string description: url used to access external systems. user-name: type: string description: username used to access external systems. password: type: string description: password used to access external systems. system-type: type: string description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm. protocol: type: string description: protocol of third party SDNC, for example netconf/snmp. ssl-cacert: type: string description: ca file content if enabled ssl on auth-url. ssl-insecure: type: boolean description: Whether to verify VIM's certificate. ip-address: type: string description: service IP of ftp server. port: type: string description: service port of ftp server. cloud-domain: type: string description: domain info for authentication. default-tenant: type: string description: default tenant of VIM. passive: type: boolean description: ftp passive mode or not. remote-path: type: string description: resource or performance data file path. system-status: type: string description: the status of external system. openstack-region-id: type: string description: OpenStack region ID used by MultiCloud plugin to interact with an OpenStack instance. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Persist common address information of external systems. ###### Related Nodes - TO cloud-region (PARENT of esr-system-info, esr-system-info BelongsTo cloud-region, MANY2ONE)(4) - TO esr-ems (PARENT of esr-system-info, esr-system-info BelongsTo esr-ems, MANY2ONE)(4) - TO esr-nfvo (PARENT of esr-system-info, esr-system-info BelongsTo esr-nfvo, ONE2ONE)(4) - TO esr-thirdparty-sdnc (PARENT of esr-system-info, esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4) - TO esr-vnfm (PARENT of esr-system-info, esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4) - FROM ext-aai-network (PARENT of esr-system-info, ext-aai-network Uses esr-system-info, ONE2MANY) For CCVPN Usecase(3) -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also -ESR-SYSTEM-INFO cannot be deleted if related to EXT-AAI-NETWORK esr-system-info-list: title: esr-system-info-list type: object properties: esr-system-info: type: array items: $ref: '#/components/schemas/esr-system-info' description: '' description: Collection of persistent block-level external system auth info. esr-thirdparty-sdnc: title: esr-thirdparty-sdnc required: - thirdparty-sdnc-id type: object properties: thirdparty-sdnc-id: type: string description: Unique ID of SDNC. location: type: string description: used for DC type to indicate the location of SDNC, such as Core or Edge. product-name: type: string description: password used to access SDNC server. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. esr-system-info-list: type: array items: $ref: '#/components/schemas/esr-system-info' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Persist SDNC address information used by ONAP SDNC. ###### Related Nodes - 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 esr-thirdparty-sdnc-list: title: esr-thirdparty-sdnc-list type: object properties: esr-thirdparty-sdnc: type: array items: $ref: '#/components/schemas/esr-thirdparty-sdnc' description: '' esr-vnfm: title: esr-vnfm required: - vnfm-id type: object properties: vnfm-id: type: string description: Unique ID of VNFM. vim-id: type: string description: indecate the VIM to deploy VNF. certificate-url: type: string description: certificate url of VNFM. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. esr-system-info-list: type: array items: $ref: '#/components/schemas/esr-system-info' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Persist VNFM address information used by VF-C. ###### Related Nodes - FROM esr-system-info (CHILD of esr-vnfm, esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1) - FROM generic-vnf( generic-vnf DependsOn esr-vnfm, MANY2ONE) -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also esr-vnfm-list: title: esr-vnfm-list type: object properties: esr-vnfm: type: array items: $ref: '#/components/schemas/esr-vnfm' description: '' evc: title: evc required: - evc-id type: object properties: evc-id: type: string description: Unique/key field for the evc object forwarding-path-topology: type: string description: Point-to-Point, Multi-Point cir-value: type: string description: Commited Information Rate cir-units: type: string description: CIR units connection-diversity-group-id: type: string description: Diversity Group ID service-hours: type: string description: formerly Performance Group esp-evc-circuit-id: type: string description: EVC Circuit ID of ESP EVC esp-evc-cir-value: type: string description: Committed Information Rate (For ESP) esp-evc-cir-units: type: string description: CIR units (For ESP) esp-itu-code: type: string description: Identifies ESP collector-pop-clli: type: string description: Collector POP CLLI (from the hostname of the access pnf) inter-connect-type-ingress: type: string description: Interconnect type on ingress side of EVC. tagmode-access-ingress: type: string description: tagode for collector side of EVC tagmode-access-egress: type: string description: tagMode for network side of EVC product-entry-id: type: string description: Product ID relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. description: >- evc object is an optional child object of the Configuration object. ###### Related Nodes - TO configuration (PARENT of evc, evc BelongsTo configuration, ONE2ONE)(4) -(4) IF this TO node is deleted, this EVC is DELETED also evcs: title: evcs type: object properties: evc: type: array items: $ref: '#/components/schemas/evc' description: '' ext-aai-network: title: ext-aai-network required: - aai-id type: object properties: aai-id: type: string description: Unique ID of the referenced AAI. schema-version: type: string description: Schema version of the referenced AAI. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. esr-system-info: allOf: - $ref: '#/components/schemas/esr-system-info' - description: >- Persist common address information of external systems. ###### Related Nodes - TO cloud-region (PARENT of esr-system-info, esr-system-info BelongsTo cloud-region, MANY2ONE)(4) - TO esr-ems (PARENT of esr-system-info, esr-system-info BelongsTo esr-ems, MANY2ONE)(4) - TO esr-nfvo (PARENT of esr-system-info, esr-system-info BelongsTo esr-nfvo, ONE2ONE)(4) - TO esr-thirdparty-sdnc (PARENT of esr-system-info, esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4) - TO esr-vnfm (PARENT of esr-system-info, esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4) - FROM ext-aai-network (PARENT of esr-system-info, ext-aai-network Uses esr-system-info, ONE2MANY) For CCVPN Usecase(3) -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also -ESR-SYSTEM-INFO cannot be deleted if related to EXT-AAI-NETWORK relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Refer to an external AAI in another ONAP. ###### Related Nodes - 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 ext-aai-networks: title: ext-aai-networks type: object properties: ext-aai-network: type: array items: $ref: '#/components/schemas/ext-aai-network' description: '' external-system: title: external-system type: object properties: esr-ems-list: type: array items: $ref: '#/components/schemas/esr-ems' description: '' esr-vnfm-list: type: array items: $ref: '#/components/schemas/esr-vnfm' description: '' esr-nfvo-list: type: array items: $ref: '#/components/schemas/esr-nfvo' description: '' esr-thirdparty-sdnc-list: type: array items: $ref: '#/components/schemas/esr-thirdparty-sdnc' description: '' description: Namespace for external system. extra-properties: title: extra-properties type: object properties: extra-property: type: array items: $ref: '#/components/schemas/extra-property' description: '' description: Extra properties for inventory item for response list extra-property: title: extra-property type: object properties: property-name: type: string property-value: type: string flavor: title: flavor required: - flavor-id - flavor-name - flavor-selflink type: object properties: flavor-id: type: string description: Flavor id, expected to be unique across cloud-region. flavor-name: type: string description: Cloud Region Flavor name flavor-vcpus: type: integer description: Number of CPUs format: int32 flavor-ram: type: integer description: Amount of memory format: int32 flavor-disk: type: integer description: Disk space format: int32 flavor-ephemeral: type: integer description: Amount of ephemeral disk space format: int32 flavor-swap: type: string description: amount of swap space allocation flavor-is-public: type: boolean description: whether flavor is available to all users or private to the tenant it was created in. flavor-selflink: type: string description: URL to endpoint where AAI can get more details flavor-disabled: type: boolean description: Boolean as to whether this flavor is no longer enabled hpa-capabilities: type: array items: $ref: '#/components/schemas/hpa-capability' description: List of flavor specific HPA Capabilities resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Openstack flavor. ###### Related Nodes - 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 flavors: title: flavors type: object properties: flavor: type: array items: $ref: '#/components/schemas/flavor' description: '' description: Collection of openstack flavors. forwarder: title: forwarder required: - sequence type: object properties: sequence: type: integer description: Unique ID of this segmentation format: int32 forwarder-role: type: string description: ingress, intermediate, egress relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. description: >- Entity describing a sequenced segment of forwarding path ###### Related Nodes - 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 forwarder-evc: title: forwarder-evc required: - forwarder-evc-id type: object properties: forwarder-evc-id: type: string description: Key for forwarder-evc object circuit-id: type: string description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC ivlan: type: string description: Internal VLAN. svlan: type: string description: SVLAN value for ingress of egress forwarder. cvlan: type: string description: CVLAN value for ingress of egress forwarder. vlan-mappings: type: array items: $ref: '#/components/schemas/vlan-mapping' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. description: >- forwarder object is an optional child object of the Configuration object. ###### Related Nodes - 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-evcs: title: forwarder-evcs type: object properties: forwarder-evc: type: array items: $ref: '#/components/schemas/forwarder-evc' description: '' forwarders: title: forwarders type: object properties: forwarder: type: array items: $ref: '#/components/schemas/forwarder' description: '' forwarding-path: title: forwarding-path required: - forwarding-path-id - forwarding-path-name type: object properties: forwarding-path-id: type: string description: Unique ID of this FP forwarding-path-name: type: string description: Name of the FP relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. selflink: type: string description: the self link for this FP forwarders: type: array items: $ref: '#/components/schemas/forwarder' description: '' description: >- Entity that describes the sequenced forwarding path between interfaces of services or resources ###### Related Nodes - 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-paths: title: forwarding-paths type: object properties: forwarding-path: type: array items: $ref: '#/components/schemas/forwarding-path' description: '' generic-vnf: title: generic-vnf required: - vnf-id - vnf-type - in-maint - is-closed-loop-disabled type: object properties: vnf-id: type: string description: Unique id of VNF. This is unique across the graph. vnf-instance-id: type: string description: vnf instance id. vnf-name: type: string description: Name of VNF. vnf-name2: type: string description: Alternate name of VNF. vnf-type: type: string description: 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: type: string description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED regional-resource-zone: type: string description: Regional way of organizing pservers, source of truth should define values prov-status: type: string description: Trigger for operational monitoring of this resource by Service Assurance systems. operational-status: type: string description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path. license-key: type: string description: OBSOLETE - do not use equipment-role: type: string description: Client should send valid enumerated value orchestration-status: type: string description: Orchestration status of this VNF, used by MSO. vnf-package-name: type: string vnf-discriptor-name: type: string description: vnf discriptor name job-id: type: string description: job id corresponding to vnf heat-stack-id: type: string description: Heat stack id corresponding to this instance, managed by MSO mso-catalog-key: type: string description: Corresponds to the SDN-C catalog id used to configure this VCE management-option: type: string description: identifier of managed customer ipv4-oam-address: type: string description: 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: type: string description: v4 Loopback0 address nm-lan-v6-address: type: string description: v6 Loopback address management-v6-address: type: string description: v6 management address vcpu: type: integer description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE format: int64 vcpu-units: type: string description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE vmemory: type: integer description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE format: int64 vmemory-units: type: string description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE vdisk: type: integer description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE format: int64 vdisk-units: type: string description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE nshd: type: integer description: number of associated SHD in vnf. format: int64 nvm: type: integer description: number of vms in vnf. format: int64 nnet: type: integer description: number of network in vnf. format: int64 in-maint: type: boolean description: 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: type: boolean description: used to indicate whether closed loop function is enabled on this node resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. summary-status: type: string description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD. encrypted-access-flag: type: boolean description: indicates whether generic-vnf access uses SSH entitlement-assignment-group-uuid: type: string description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE - See child relationships. entitlement-resource-uuid: type: string description: UUID of the specific entitlement resource. OBSOLETE - See child relationships. license-assignment-group-uuid: type: string description: UUID of the license assignment group. OBSOLETE - See child relationships. license-key-uuid: type: string description: UUID of the actual license resource. OBSOLETE - See child relationships. model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. persona-model-version: type: string description: the ASDC model version for this resource or service model. model-customization-id: type: string description: captures the id of all the configuration used to customize the resource for the service. widget-model-id: type: string description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. widget-model-version: type: string description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. as-number: type: string description: as-number of the VNF regional-resource-subzone: type: string description: represents sub zone of the rr plane nf-type: type: string description: Generic description of the type of NF nf-function: type: string description: English description of Network function that the specific VNF deployment is providing nf-role: type: string description: role in the network that this model will be providing nf-naming-code: type: string description: string assigned to this model used for naming purposes selflink: type: string description: Path to the controller object. ipv4-oam-gateway-address: type: string description: Gateway address ipv4-oam-gateway-address-prefix-length: type: integer description: Prefix length for oam-address format: int32 vlan-id-outer: type: integer description: Temporary location for S-TAG to get to VCE format: int64 nm-profile-name: type: string description: Network Management profile of this VNF relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' l-interfaces: type: array items: $ref: '#/components/schemas/l-interface' description: '' lag-interfaces: type: array items: $ref: '#/components/schemas/lag-interface' description: '' vf-modules: type: array items: $ref: '#/components/schemas/vf-module' description: '' licenses: type: array items: $ref: '#/components/schemas/license' description: '' entitlements: type: array items: $ref: '#/components/schemas/entitlement' description: '' description: >- General purpose VNF ###### Related Nodes - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY) - TO cloud-region( generic-vnf LocatedIn cloud-region, MANY2ONE) - TO complex( generic-vnf LocatedIn complex, MANY2MANY) - TO configuration( generic-vnf Uses configuration, ONE2MANY)(2) - TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY) - TO esr-vnfm( generic-vnf DependsOn esr-vnfm, MANY2ONE) - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY) - TO instance-group( generic-vnf Uses instance-group, ONE2MANY) - TO 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 tenant( generic-vnf BelongsTo tenant, MANY2ONE) - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY) - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE) - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY) - TO vserver( generic-vnf HostedOn vserver, ONE2MANY) - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY) - FROM contact( contact supports generic-vnf, MANY2MANY) - FROM device( device Uses generic-vnf, ONE2MANY) For CCVPN Usecase - FROM entitlement (CHILD of generic-vnf, entitlement BelongsTo generic-vnf, MANY2ONE)(1) - FROM forwarder( forwarder AppliesTo generic-vnf, MANY2MANY) Points to the generic-vnf(s) involved in this forwarding step. - FROM 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 metadatum( metadatum AppliesTo generic-vnf, MANY2MANY) AAI-2154 For BBS Usecase - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY) - FROM platform( platform Uses generic-vnf, MANY2MANY) - FROM 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 generic-vnfs: title: generic-vnfs type: object properties: generic-vnf: type: array items: $ref: '#/components/schemas/generic-vnf' description: '' description: Collection of VNFs group-assignment: title: group-assignment required: - group-id - group-type - group-name type: object properties: group-id: type: string description: Group id, expected to be unique across cloud-region. group-type: type: string description: Group type - the type of group this instance refers to group-name: type: string description: Group name - name assigned to the group group-description: type: string description: Group description - description of the group resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Openstack group-assignment used to store exclusivity groups (EG). ###### Related Nodes - 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-assignments: title: group-assignments type: object properties: group-assignment: type: array items: $ref: '#/components/schemas/group-assignment' description: '' description: Collection of openstack group assignments host-route: title: host-route required: - host-route-id - route-prefix - next-hop type: object properties: host-route-id: type: string description: host-route id route-prefix: type: string description: subnet prefix next-hop: type: string description: Could be ip-address, hostname, or service-instance next-hop-type: type: string description: Should be ip-address, hostname, or service-instance to match next-hop resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- ###### Related Nodes - 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-routes: title: host-routes type: object properties: host-route: type: array items: $ref: '#/components/schemas/host-route' description: '' hpa-capabilities: title: hpa-capabilities type: object properties: hpa-capability: type: array items: $ref: '#/components/schemas/hpa-capability' description: '' description: Collection of HPA Capabilities hpa-capability: title: hpa-capability required: - hpa-capability-id - hpa-feature type: object properties: hpa-capability-id: type: string description: UUID to uniquely identify a HPA capability hpa-feature: type: string description: Name of the HPACapability hpa-version: type: string description: HPA schema version architecture: type: string description: Hardware architecture resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' hpa-feature-attributes: type: array items: $ref: '#/components/schemas/hpa-feature-attributes' description: '' description: >- Represents a HPA capability ###### Related Nodes - 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-capacity: title: hpa-capacity required: - hpa-capacity-key type: object properties: hpa-capacity-key: type: string description: Composite key formed with hpaFeature and append list of hpaFeatureAttributes needed for capacity check hpa-capacity-value: type: string description: JSON string specifying the capacity (total,free), unit and metadata of the specific HPA attribute resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- HPA Capacity information for compute node ###### Related Nodes - 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-feature-attributes: title: hpa-feature-attributes required: - hpa-attribute-key type: object properties: hpa-attribute-key: type: string description: name of the specific HPA attribute hpa-attribute-value: type: string description: JSON string specifying the value, unit and type of the specific HPA attribute resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- HPA Capability Feature attributes ###### Related Nodes - 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 image: title: image required: - image-id - image-name - image-os-distro - image-os-version - image-selflink type: object properties: image-id: type: string description: Image id, expected to be unique across cloud region image-name: type: string description: Image name image-architecture: type: string description: Operating system architecture. image-os-distro: type: string description: The common name of the operating system distribution in lowercase image-os-version: type: string description: The operating system version as specified by the distributor. application: type: string description: The application that the image instantiates. application-vendor: type: string description: The vendor of the application. application-version: type: string description: The version of the application. image-selflink: type: string description: URL to endpoint where AAI can get more details resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' metadata: type: array items: $ref: '#/components/schemas/metadatum' description: '' description: >- Openstack image. ###### Related Nodes - 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 images: title: images type: object properties: image: type: array items: $ref: '#/components/schemas/image' description: '' description: Collectio of Openstack images. include-node-filter: title: include-node-filter type: object properties: include-node-type: type: string instance-filters: title: instance-filters type: object properties: instance-filter: type: array items: type: object description: '' description: InstanceFilters for performing a named-query or model query instance-group: title: instance-group required: - id - instance-group-type type: object properties: id: type: string description: Instance Group ID, UUID assigned to this instance. instance-group-role: type: string description: role of the instance group. model-invariant-id: type: string description: ASDC model id for this resource or service model. model-version-id: type: string description: ASDC model version uid for this resource model. description: type: string description: Descriptive text to help identify the usage of this instance-group instance-group-type: type: string description: Only valid value today is lower case ha for high availability resource-version: type: string description: Concurrency value instance-group-name: type: string description: Instance-Group Name. instance-group-function: type: string description: Instance-Group Function relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- General mechanism for grouping instances ###### Related Nodes - 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 Uses instance-group, ONE2MANY) MSO creates this edge on VNF Group Service creation - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY) - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY) - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY) - FROM vnfc( vnfc MemberOf instance-group, MANY2MANY) -(4) IF this TO node is deleted, this INSTANCE-GROUP is DELETED also instance-groups: title: instance-groups type: object properties: instance-group: type: array items: $ref: '#/components/schemas/instance-group' description: '' description: Collection of openstack route table references inventory: title: inventory type: object properties: cloud-infrastructure: allOf: - $ref: '#/components/schemas/cloud-infrastructure' - description: Namespace for cloud infrastructure. external-system: allOf: - $ref: '#/components/schemas/external-system' - description: Namespace for external system. business: allOf: - $ref: '#/components/schemas/business' - description: Namespace for business related constructs service-design-and-creation: allOf: - $ref: '#/components/schemas/service-design-and-creation' - description: Namespace for objects managed by ASDC network: allOf: - $ref: '#/components/schemas/network' - description: Namespace for network inventory resources. common: allOf: - $ref: '#/components/schemas/common' - description: Namespace for common inventory resources. inventory-item: title: inventory-item type: object properties: inventory-item-type: type: string inventory-item-link: type: string inventory-item-data: type: array items: $ref: '#/components/schemas/inventory-item-data' description: '' tagged-inventory-item-list: type: array items: $ref: '#/components/schemas/tagged-inventory-item-list' description: '' inventory-item-data: title: inventory-item-data type: object properties: property-name: type: string property-value: type: string inventory-response-item: title: inventory-response-item type: object properties: model-name: type: string extra-properties: allOf: - $ref: '#/components/schemas/extra-properties' - description: Extra properties for inventory item for response list inventory-response-items: allOf: - $ref: '#/components/schemas/inventory-response-items' - description: Container for inventory items in response list description: Inventory item for response list inventory-response-items: title: inventory-response-items type: object properties: inventory-response-item: type: array items: $ref: '#/components/schemas/inventory-response-item' description: '' description: Container for inventory items in response list ipsec-configuration: title: ipsec-configuration required: - ipsec-configuration-id type: object properties: ipsec-configuration-id: type: string description: UUID of this configuration requested-vig-address-type: type: string description: Indicate the type of VIG server like AVPN, INTERNET, BOTH requested-encryption-strength: type: string description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc requested-dmz-type: type: string description: Shared DMZ or a DMZ specific to a customer shared-dmz-network-address: type: string description: Network address of shared DMZ requested-customer-name: type: string description: If the DMZ is a custom DMZ, this field will indicate the customer information ike-version: type: string description: can be 1 or 2 ikev1-authentication: type: string description: Contains values like md5, sha1, sha256, sha384 ikev1-encryption: type: string description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc ikev1-dh-group: type: string description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14 ikev1-am-group-id: type: string description: Group name defined in VIG for clients using aggressive mode ikev1-am-password: type: string description: pre-shared key for the above group name ikev1-sa-lifetime: type: string description: Lifetime for IKEv1 SA ipsec-authentication: type: string description: md5, sha1, sha256, sha384 ipsec-encryption: type: string description: 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc ipsec-sa-lifetime: type: string description: Life time for IPSec SA ipsec-pfs: type: string description: enable PFS or not xauth-userid: type: string description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName xauth-user-password: type: string description: Encrypted using the Juniper $9$ algorithm dpd-interval: type: string description: The time between DPD probe dpd-frequency: type: string description: Maximum number of DPD before claiming the tunnel is down resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' vig-servers: type: array items: $ref: '#/components/schemas/vig-server' description: '' description: >- 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 ###### Related Nodes - 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-configurations: title: ipsec-configurations type: object properties: ipsec-configuration: type: array items: $ref: '#/components/schemas/ipsec-configuration' description: '' key-data: title: key-data type: object properties: key-name: type: string key-value: type: string l-interface: title: l-interface required: - interface-name - is-port-mirrored - in-maint - is-ip-unnumbered type: object properties: interface-name: type: string description: Name given to the interface interface-role: type: string description: E.g., CUSTOMER, UPLINK, etc. v6-wan-link-ip: type: string description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B. selflink: type: string description: URL to endpoint where AAI can get more details interface-id: type: string description: ID of interface macaddr: type: string description: MAC address for the interface network-name: type: string description: Name of the network management-option: type: string description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER interface-description: type: string description: Human friendly text regarding this interface. is-port-mirrored: type: boolean description: boolean indicatating whether or not port is a mirrored. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. in-maint: type: boolean description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) prov-status: type: string description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV]. is-ip-unnumbered: type: boolean description: Flag indicating the interface uses the IP Unnumbered configuration. allowed-address-pairs: type: string description: Freeform field for storing an ip address, list of ip addresses or a subnet block. priority: type: integer description: Priority used for fail-over. Valid values 1-1024, with 1 being the highest priority. format: int32 vlans: type: array items: $ref: '#/components/schemas/vlan' description: '' sriov-vfs: type: array items: $ref: '#/components/schemas/sriov-vf' description: '' l-interfaces: type: array items: $ref: '#/components/schemas/l-interface' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' l3-interface-ipv4-address-list: type: array items: $ref: '#/components/schemas/l3-interface-ipv4-address-list' description: '' l3-interface-ipv6-address-list: type: array items: $ref: '#/components/schemas/l3-interface-ipv6-address-list' description: '' admin-status: type: string description: Administrative status of the interface. Valid values are 'up', 'down', or 'testing'. description: >- Logical interfaces, e.g., a vnic. ###### Related Nodes - 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 vrf( vrf Uses l-interface, ONE2MANY) - FROM l3-interface-ipv4-address-list (CHILD of l-interface, l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1) - FROM l3-interface-ipv6-address-list (CHILD of l-interface, l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1) - FROM lag-interface( lag-interface Uses l-interface, 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 l-interfaces: title: l-interfaces type: object properties: l-interface: type: array items: $ref: '#/components/schemas/l-interface' description: '' description: Collection of logical interfaces. l3-interface-ipv4-address-list: title: l3-interface-ipv4-address-list required: - l3-interface-ipv4-address type: object properties: l3-interface-ipv4-address: type: string description: IP address l3-interface-ipv4-prefix-length: type: integer description: Prefix length, 32 for single address format: int64 vlan-id-inner: type: integer description: Inner VLAN tag format: int64 vlan-id-outer: type: integer description: Outer VLAN tag format: int64 is-floating: type: boolean description: Indicator of fixed or floating address resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. neutron-network-id: type: string description: Neutron network id of the interface that address belongs to neutron-subnet-id: type: string description: Neutron id of subnet that address belongs to relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- IPv4 Address Range ###### Related Nodes - 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-ipv6-address-list: title: l3-interface-ipv6-address-list required: - l3-interface-ipv6-address type: object properties: l3-interface-ipv6-address: type: string description: IP address l3-interface-ipv6-prefix-length: type: integer description: Prefix length, 128 for single address format: int64 vlan-id-inner: type: integer description: Inner VLAN tag format: int64 vlan-id-outer: type: integer description: Outer VLAN tag format: int64 is-floating: type: boolean description: Indicator of fixed or floating address resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. neutron-network-id: type: string description: Neutron network id of the interface that address belongs to neutron-subnet-id: type: string description: Neutron id of subnet that address belongs to relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- IPv6 Address Range ###### Related Nodes - 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-network: title: l3-network required: - network-id - is-bound-to-vpn - is-provider-network - is-shared-network - is-external-network type: object properties: network-id: type: string description: Network ID, should be uuid. Unique across A&AI. network-name: type: string description: Name of the network, governed by some naming convention.. network-type: type: string description: Type of the network - who defines these values? network-role: type: string description: Role the network plans - who defines these values? network-technology: type: string description: Network technology - who defines these values? neutron-network-id: type: string description: Neutron network id of this Interface is-bound-to-vpn: type: boolean description: Set to true if bound to VPN service-id: type: string description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED network-role-instance: type: integer description: network role instance format: int64 resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. orchestration-status: type: string description: Orchestration status of this VNF, mastered by MSO heat-stack-id: type: string description: Heat stack id corresponding to this instance, managed by MSO mso-catalog-key: type: string description: Corresponds to the SDN-C catalog id used to configure this VCE contrail-network-fqdn: type: string description: Contrail FQDN for the network model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. persona-model-version: type: string description: the ASDC model version for this resource or service model. model-customization-id: type: string description: captures the id of all the configuration used to customize the resource for the service. widget-model-id: type: string description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. widget-model-version: type: string description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. physical-network-name: type: string description: Name associated with the physical network. is-provider-network: type: boolean description: boolean indicatating whether or not network is a provider network. is-shared-network: type: boolean description: boolean indicatating whether or not network is a shared network. is-external-network: type: boolean description: boolean indicatating whether or not network is an external network. selflink: type: string description: Path to the controller object. operational-status: type: string description: Indicator for whether the resource is considered operational. is-trunked: type: boolean description: Trunked network indication. subnets: type: array items: $ref: '#/components/schemas/subnet' description: '' ctag-assignments: type: array items: $ref: '#/components/schemas/ctag-assignment' description: '' segmentation-assignments: type: array items: $ref: '#/components/schemas/segmentation-assignment' description: '' aggregate-routes: type: array items: $ref: '#/components/schemas/aggregate-route' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding description: >- Generic network definition ###### Related Nodes - 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 aggregate-route (CHILD of l3-network, aggregate-route BelongsTo l3-network, MANY2ONE)(1) - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY) - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY) - FROM complex( complex Uses l3-network, MANY2MANY) - FROM configuration( configuration PartOf l3-network, MANY2MANY) - FROM ctag-assignment (CHILD of l3-network, ctag-assignment BelongsTo l3-network, MANY2ONE)(1) - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY) - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY) - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY) - FROM l3-network( l3-network Uses l3-network, MANY2MANY) - 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) - FROM vrf( vrf Uses l3-network, ONE2MANY) A vrf uses many l3-networks -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also l3-networks: title: l3-networks type: object properties: l3-network: type: array items: $ref: '#/components/schemas/l3-network' description: '' lag-interface: title: lag-interface required: - interface-name - in-maint type: object properties: interface-name: type: string description: Name that identifies the link aggregate interface interface-description: type: string description: Human friendly text regarding this interface. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. speed-value: type: string description: Captures the numeric part of the speed speed-units: type: string description: Captures the units corresponding to the speed interface-id: type: string description: ID of interface interface-role: type: string description: Role assigned to this Interface, should use values as defined in ONAP Yang models. prov-status: type: string description: Trigger for operational monitoring of this resource by Service Assurance systems. in-maint: type: boolean description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' l-interfaces: type: array items: $ref: '#/components/schemas/l-interface' description: '' description: >- Link aggregate interface ###### Related Nodes - 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 lag-interfaces: title: lag-interfaces type: object properties: lag-interface: type: array items: $ref: '#/components/schemas/lag-interface' description: '' description: Collection of link aggregate interfaces. lag-link: title: lag-link required: - link-name type: object properties: link-name: type: string description: Alphabetical concatenation of lag-interface names resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- LAG links can connect lag-interfaces ###### Related Nodes - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3) - FROM logical-link( logical-link Uses lag-link, MANY2MANY) -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also lag-links: title: lag-links type: object properties: lag-link: type: array items: $ref: '#/components/schemas/lag-link' description: '' description: Collection of link aggregation connections lan-port-config: title: lan-port-config required: - lan-port-config-id type: object properties: lan-port-config-id: type: string description: Uniquely identifies this lan-port-config by id lan-port-config-name: type: string description: Store the name of this lan-port-config. description: type: string description: Store the description of this lan-port-config. device-id: type: string description: Store the device-id of this lan-port-config. port-id: type: string description: Store the port-id of this lan-port-config. ipv4-address: type: string description: Store the ipv4-address of this lan-port-config. ipv6-address: type: string description: Store the ipv6-address of this lan-port-config. vlan-tag: type: string description: Store the vlan-tag of this lan-port-config. input-bandwidth: type: string description: Store the input-bandwidth of this lan-port-config. output-bandwidth: type: string description: Store the output-bandwidth of this lan-port-config. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. dhcp-services: type: array items: $ref: '#/components/schemas/dhcp-service' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Instance of a lan-port-config ###### Related Nodes - 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-configs: title: lan-port-configs type: object properties: lan-port-config: type: array items: $ref: '#/components/schemas/lan-port-config' description: '' description: Collection of lan-port-configs license: title: license required: - group-uuid - resource-uuid type: object properties: group-uuid: type: string description: Unique ID for the license group the resource belongs to, should be uuid. resource-uuid: type: string description: Unique ID of a license resource. resource-version: type: string description: Concurrency value relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Metadata for license group. ###### Related Nodes - 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 licenses: title: licenses type: object properties: license: type: array items: $ref: '#/components/schemas/license' description: '' description: Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management line-of-business: title: line-of-business required: - line-of-business-name type: object properties: line-of-business-name: type: string description: Name of the line-of-business (product) resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- describes a line-of-business ###### Related Nodes - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY) - TO l3-network( line-of-business Uses l3-network, MANY2MANY) lines-of-business: title: lines-of-business type: object properties: line-of-business: type: array items: $ref: '#/components/schemas/line-of-business' description: '' description: Collection of lines-of-business logical-link: title: logical-link required: - link-name - in-maint - link-type type: object properties: link-name: type: string description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ in-maint: type: boolean description: 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. link-type: type: string description: Type of logical link, e.g., evc speed-value: type: string description: Captures the numeric part of the speed speed-units: type: string description: Captures the units corresponding to the speed ip-version: type: string description: v4, v6, or ds for dual stack routing-protocol: type: string description: For example, static or BGP resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. widget-model-id: type: string description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. widget-model-version: type: string description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. operational-status: type: string description: Indication of operational status of the logical link. prov-status: type: string description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. link-role: type: string description: Indication of the network use of the logical link. link-name2: type: string description: Alias or alternate name (CLCI or D1 name). link-id: type: string description: UUID of the logical-link, SDNC generates this. circuit-id: type: string description: Circuit id purpose: type: string description: Reason for this entity, role it is playing relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Logical links generally connect l-interfaces but are used to express logical connectivity between two points ###### Related Nodes - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY) - TO ext-aai-network( logical-link BelongsTo ext-aai-network, MANY2MANY) For CCVPN Usecase(2) - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY) - TO l-interface( logical-link Source l-interface, MANY2MANY)(4) - TO l-interface( logical-link Destination l-interface, MANY2MANY)(4) - TO lag-link( logical-link Uses lag-link, MANY2MANY) - TO logical-link( logical-link Uses logical-link, MANY2MANY) - TO pnf( logical-link BridgedTo pnf, MANY2MANY) - TO pserver( logical-link BridgedTo pserver, MANY2MANY) - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY) - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY) - FROM configuration( configuration Uses logical-link, ONE2MANY)(3) - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3) - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3) - FROM logical-link( logical-link Uses logical-link, MANY2MANY) - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE) - FROM service-instance( service-instance Uses logical-link, MANY2MANY)(3) - FROM vlan( vlan Uses logical-link, MANY2MANY)(3) -(2) IF this LOGICAL-LINK node is deleted, this TO node is DELETED also -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also -(4) IF this TO node is deleted, this LOGICAL-LINK is DELETED also logical-links: title: logical-links type: object properties: logical-link: type: array items: $ref: '#/components/schemas/logical-link' description: '' description: Collection of logical connections metadata: title: metadata type: object properties: metadatum: type: array items: $ref: '#/components/schemas/metadatum' description: '' description: Collection of metadatum (key/value pairs) metadatum: title: metadatum required: - metaname - metaval type: object properties: metaname: type: string metaval: type: string resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. description: >- Key/value pairs ###### Related Nodes - TO configuration (PARENT of metadatum, metadatum BelongsTo configuration, MANY2ONE)(4) - TO connector (PARENT of metadatum, metadatum BelongsTo connector, MANY2ONE)(4) - TO cp( metadatum AppliesTo cp, MANY2MANY) AAI-2154 For BBS Usecase - TO generic-vnf( metadatum AppliesTo generic-vnf, MANY2MANY) AAI-2154 For BBS Usecase - TO image (PARENT of metadatum, metadatum BelongsTo image, MANY2ONE)(4) - TO model-ver (PARENT of metadatum, metadatum BelongsTo model-ver, MANY2ONE)(4) - TO pnf( metadatum AppliesTo pnf, MANY2MANY) AAI-2154 For BBS Usecase - TO service-instance (PARENT of metadatum, metadatum BelongsTo service-instance, MANY2ONE)(4) -(4) IF this TO node is deleted, this METADATUM is DELETED also model: title: model required: - model-invariant-id - model-type type: object properties: model-invariant-id: type: string description: Unique identifier corresponding to the main definition of a model in ASDC model-type: type: string description: Type of the model, e.g., service, resource, widget, etc. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. model-vers: type: array items: $ref: '#/components/schemas/model-ver' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version ###### Related Nodes - 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-and-named-query-search: title: model-and-named-query-search type: object properties: query-parameters: allOf: - $ref: '#/components/schemas/query-parameters' - description: QueryParameters for performing a named-query or model query instance-filters: allOf: - $ref: '#/components/schemas/instance-filters' - description: InstanceFilters for performing a named-query or model query secondary-filts: allOf: - $ref: '#/components/schemas/secondary-filts' - description: SecondaryFilts for performing a named-query or model query top-node-type: type: string secondary-filter-cut-point: type: string description: ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query model-constraint: title: model-constraint required: - model-constraint-uuid - constrained-element-set-uuid-to-replace type: object properties: model-constraint-uuid: type: string constrained-element-set-uuid-to-replace: type: string constrained-element-sets: type: array items: $ref: '#/components/schemas/constrained-element-set' description: '' resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. description: >- This is how we would capture constraints defining allowed sets of elements. ###### Related Nodes - 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-constraints: title: model-constraints type: object properties: model-constraint: type: array items: $ref: '#/components/schemas/model-constraint' description: '' model-element: title: model-element required: - model-element-uuid - new-data-del-flag - cardinality type: object properties: model-element-uuid: type: string new-data-del-flag: type: string description: Indicates whether this element was created as part of instantiation from this model cardinality: type: string description: How many of this type of element are required/allowed linkage-points: type: string resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. model-elements: type: array items: $ref: '#/components/schemas/model-element' description: Defines how other models combine to make up a higher-level model model-constraints: type: array items: $ref: '#/components/schemas/model-constraint' description: Describes new constraints on this model element that are not part of that model's definition relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Defines how other models combine to make up a higher-level model. ###### Related Nodes - 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-elements: title: model-elements type: object properties: model-element: type: array items: $ref: '#/components/schemas/model-element' description: '' model-ver: title: model-ver required: - model-version-id - model-name - model-version type: object properties: model-version-id: type: string description: Unique identifier corresponding to one version of a model in ASDC model-name: type: string description: Name of the model, which can change from version to version. model-version: type: string description: Version distribution-status: type: string description: Distribution Status model-description: type: string description: Description resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. model-elements: type: array items: $ref: '#/components/schemas/model-element' description: '' metadata: type: array items: $ref: '#/components/schemas/metadatum' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models ###### Related Nodes - 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-vers: title: model-vers type: object properties: model-ver: type: array items: $ref: '#/components/schemas/model-ver' description: '' models: title: models type: object properties: model: type: array items: $ref: '#/components/schemas/model' description: '' description: Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models multicast-configuration: title: multicast-configuration required: - multicast-configuration-id - multicast-protocol - rp-type type: object properties: multicast-configuration-id: type: string description: Unique id of multicast configuration. multicast-protocol: type: string description: protocol of multicast configuration rp-type: type: string description: rp type of multicast configuration resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- ###### Related Nodes - FROM vlan( vlan Uses multicast-configuration, MANY2MANY) multicast-configurations: title: multicast-configurations type: object properties: multicast-configuration: type: array items: $ref: '#/components/schemas/multicast-configuration' description: '' description: multicast configuration of generic-vnf ip-address named-queries: title: named-queries type: object properties: named-query: type: array items: $ref: '#/components/schemas/named-query' description: '' named-query: title: named-query required: - named-query-uuid - named-query-name - named-query-version type: object properties: named-query-uuid: type: string named-query-name: type: string named-query-version: type: string required-input-param: type: string description: type: string resource-version: type: string named-query-elements: type: array items: $ref: '#/components/schemas/named-query-element' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- TBD ###### Related Nodes - 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-element: title: named-query-element required: - named-query-element-uuid type: object properties: named-query-element-uuid: type: string property-collect-list: type: string resource-version: type: string property-limit-desc: type: string do-not-output: type: string named-query-elements: type: array items: $ref: '#/components/schemas/named-query-element' description: '' related-lookups: type: array items: $ref: '#/components/schemas/related-lookup' description: '' property-constraints: type: array items: $ref: '#/components/schemas/property-constraint' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- TBD ###### Related Nodes - 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-elements: title: named-query-elements type: object properties: named-query-element: type: array items: $ref: '#/components/schemas/named-query-element' description: '' network: title: network type: object properties: logical-links: type: array items: $ref: '#/components/schemas/logical-link' description: '' site-pair-sets: type: array items: $ref: '#/components/schemas/site-pair-set' description: '' vpn-bindings: type: array items: $ref: '#/components/schemas/vpn-binding' description: '' vpls-pes: type: array items: $ref: '#/components/schemas/vpls-pe' description: '' multicast-configurations: type: array items: $ref: '#/components/schemas/multicast-configuration' description: '' vces: type: array items: $ref: '#/components/schemas/vce' description: '' vnfcs: type: array items: $ref: '#/components/schemas/vnfc' description: '' l3-networks: type: array items: $ref: '#/components/schemas/l3-network' description: '' network-policies: type: array items: $ref: '#/components/schemas/network-policy' description: '' generic-vnfs: type: array items: $ref: '#/components/schemas/generic-vnf' description: '' lag-links: type: array items: $ref: '#/components/schemas/lag-link' description: '' newvces: type: array items: $ref: '#/components/schemas/newvce' description: '' pnfs: type: array items: $ref: '#/components/schemas/pnf' description: '' physical-links: type: array items: $ref: '#/components/schemas/physical-link' description: '' ipsec-configurations: type: array items: $ref: '#/components/schemas/ipsec-configuration' description: '' route-table-references: type: array items: $ref: '#/components/schemas/route-table-reference' description: '' instance-groups: type: array items: $ref: '#/components/schemas/instance-group' description: '' zones: type: array items: $ref: '#/components/schemas/zone' description: '' configurations: type: array items: $ref: '#/components/schemas/configuration' description: '' forwarding-paths: type: array items: $ref: '#/components/schemas/forwarding-path' description: '' collections: type: array items: $ref: '#/components/schemas/collection' description: '' vlan-tags: type: array items: $ref: '#/components/schemas/vlan-tag' description: '' connectivities: type: array items: $ref: '#/components/schemas/connectivity' description: '' lan-port-configs: type: array items: $ref: '#/components/schemas/lan-port-config' description: '' network-resources: type: array items: $ref: '#/components/schemas/network-resource' description: '' site-resources: type: array items: $ref: '#/components/schemas/site-resource' description: '' sdwan-vpns: type: array items: $ref: '#/components/schemas/sdwan-vpn' description: '' devices: type: array items: $ref: '#/components/schemas/device' description: '' wan-port-configs: type: array items: $ref: '#/components/schemas/wan-port-config' description: '' ext-aai-networks: type: array items: $ref: '#/components/schemas/ext-aai-network' description: '' description: Namespace for network inventory resources. network-policies: title: network-policies type: object properties: network-policy: type: array items: $ref: '#/components/schemas/network-policy' description: '' network-policy: title: network-policy required: - network-policy-id type: object properties: network-policy-id: type: string description: UUID representing unique key to this instance network-policy-fqdn: type: string description: Contrail FQDN for the policy heat-stack-id: type: string description: ID for the openStack Heat instance resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- ###### Related Nodes - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE) - FROM l3-network( l3-network Uses network-policy, MANY2MANY) network-profile: title: network-profile required: - nm-profile-name type: object properties: nm-profile-name: type: string description: Unique name of network profile. community-string: type: string description: Encrypted SNMP community string resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Network profile populated by SDN-GP for SNMP ###### Related Nodes - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY) network-profiles: title: network-profiles type: object properties: network-profile: type: array items: $ref: '#/components/schemas/network-profile' description: '' description: Collection of network profiles network-resource: title: network-resource required: - network-id type: object properties: network-id: type: string description: Uniquely identifies this network-resource by id provider-id: type: string description: Store the id of the provider of this network-resource. client-id: type: string description: Store the id of the client of this network-resource. te-topo-id: type: string description: Store the id of the te-topo of this network-resource. selflink: type: string description: Store the link to get more information for this object. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Instance of a network-resource ###### Related Nodes - 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-resources: title: network-resources type: object properties: network-resource: type: array items: $ref: '#/components/schemas/network-resource' description: '' description: Collection of network-resources network-technologies: title: network-technologies type: object properties: network-technology: type: array items: $ref: '#/components/schemas/network-technology' description: '' description: The network-technology object is used to capture the supported network technologies of a cloud-region. network-technology: title: network-technology required: - network-technology-id - network-technology-name type: object properties: network-technology-id: type: string description: Unique identifier of the network-technology object (UUID) network-technology-name: type: string description: The network-technology that a cloud-region can support. Current valid values- CONTRAIL AIC_SR_IOV OVS STANDARD-SR-IOV resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- The network-technology object is used to capture the supported network technologies of a cloud-region. ###### Related Nodes - FROM cloud-region( cloud-region Uses network-technology, MANY2MANY) newvce: title: newvce required: - vnf-id2 - vnf-name - vnf-type type: object properties: vnf-id2: type: string description: Unique id of VNF, can't use same attribute name right now until we promote this new object vnf-name: type: string description: Name of VNF. vnf-name2: type: string description: Alternate name of VNF. vnf-type: type: string description: 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: type: string description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. operational-status: type: string description: Indicator for whether the resource is considered operational license-key: type: string description: OBSOLETE - do not use ipv4-oam-address: type: string description: 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: type: string description: Client should send valid enumerated value. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. ipv4-loopback0-address: type: string description: v4 Loopback0 address orchestration-status: type: string description: Orchestration status of this VNF, mastered by MSO. heat-stack-id: type: string description: Heat stack id corresponding to this instance, managed by MSO mso-catalog-key: type: string description: Corresponds to the SDN-C catalog id used to configure this VCE relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' l-interfaces: type: array items: $ref: '#/components/schemas/l-interface' description: '' description: >- This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. ###### Related Nodes - 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 newvces: title: newvces type: object properties: newvce: type: array items: $ref: '#/components/schemas/newvce' description: '' description: This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. nodes: title: nodes type: object properties: inventory-item-data: type: array items: $ref: '#/components/schemas/inventory-item-data' description: '' nos-server: title: nos-server required: - nos-server-id - nos-server-name - vendor - nos-server-selflink - in-maint type: object properties: nos-server-id: type: string description: Unique identifier for this nos relative to its tenant nos-server-name: type: string description: Name of nos vendor: type: string description: uCPE vendor prov-status: type: string description: Trigger for operational monitoring of this resource by Service Assurance systems. nos-server-selflink: type: string description: URL to endpoint where AAI can get more details in-maint: type: boolean description: 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: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- nos-server is the execution environment that will have images, certain versions of VNOS, running on it. ###### Related Nodes - 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-servers: title: nos-servers type: object properties: nos-server: type: array items: $ref: '#/components/schemas/nos-server' description: '' description: nos-server is the execution environment that will have images, certain versions of VNOS, running on it. notification-event: title: notification-event type: object properties: cambria.partition: type: string notification-event-header: $ref: '#/components/schemas/notification-event-header' notification-event-header: title: notification-event-header type: object properties: id: type: string timestamp: type: string source-name: type: string domain: type: string sequence-number: type: string severity: type: string event-type: type: string version: type: string action: type: string entity-type: type: string top-entity-type: type: string entity-link: type: string status: type: string notify: title: notify required: - event-id type: object properties: event-id: type: string node-type: type: string event-trigger: type: string key-data: type: array items: $ref: '#/components/schemas/key-data' description: '' selflink: type: string oam-network: title: oam-network required: - network-uuid - network-name - cvlan-tag type: object properties: network-uuid: type: string description: UUID of the network. Unique across a cloud-region network-name: type: string description: Name of the network. cvlan-tag: type: integer description: cvlan-id format: int64 ipv4-oam-gateway-address: type: string description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network ipv4-oam-gateway-address-prefix-length: type: integer description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network format: int32 resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: "OAM network, to be deprecated shortly. Do not use for new purposes. \n###### Related Nodes\n- TO cloud-region (PARENT of oam-network, oam-network BelongsTo cloud-region, MANY2ONE)\n- TO complex( oam-network AppliesTo complex, MANY2MANY)\n- TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)" oam-networks: title: oam-networks type: object properties: oam-network: type: array items: $ref: '#/components/schemas/oam-network' description: '' description: Collection of OAM networks, to be deprecated shortly. Do not use for new purposes. operational-environment: title: operational-environment required: - operational-environment-id - operational-environment-name - operational-environment-type - operational-environment-status - tenant-context - workload-context type: object properties: operational-environment-id: type: string description: UUID of an operational environment operational-environment-name: type: string description: Operational Environment name operational-environment-type: type: string description: Operational Environment Type. operational-environment-status: type: string description: Status tenant-context: type: string description: Tenant Context. workload-context: type: string description: Workload Context. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- It is a logical partition of the cloud which allows to have multiple environments in the production AIC. ###### Related Nodes - TO operational-environment( operational-environment Uses operational-environment, MANY2MANY) - FROM operational-environment( operational-environment Uses operational-environment, MANY2MANY) operational-environments: title: operational-environments type: object properties: operational-environment: type: array items: $ref: '#/components/schemas/operational-environment' description: '' description: a logical partition of the cloud which allows to have multiple environments in the production AIC. overloaded-model: title: overloaded-model required: - model-invariant-id - model-name-version-id - model-type - model-name - model-id - model-version type: object properties: model-invariant-id: type: string description: Unique identifier corresponding to the main definition of a model in ASDC model-name-version-id: type: string description: Unique identifier corresponding to one version of a model in ASDC model-type: type: string description: Type of the model, e.g., service, resource, widget, etc. model-name: type: string description: Name of the model, which can change from version to version. model-id: type: string description: Invariant unique ID which does not change from version to version model-version: type: string description: Version model-description: type: string description: Description resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. model-vers: $ref: '#/components/schemas/model-vers' relationship-list: $ref: '#/components/schemas/relationship-list' description: Allows for legacy POST of old-style and new-style models owning-entities: title: owning-entities type: object properties: owning-entity: type: array items: $ref: '#/components/schemas/owning-entity' description: '' description: Collection of owning-entities owning-entity: title: owning-entity required: - owning-entity-id - owning-entity-name type: object properties: owning-entity-id: type: string description: UUID of an owning entity owning-entity-name: type: string description: Owning entity name resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- describes an owning-entity ###### Related Nodes - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE) p-interface: title: p-interface required: - interface-name - in-maint type: object properties: interface-name: type: string description: Name that identifies the physical interface selflink: type: string description: URL to endpoint where AAI can get more details. speed-value: type: string description: Captures the numeric part of the speed speed-units: type: string description: Captures the units corresponding to the speed port-description: type: string description: Nature of the services and connectivity on this port. equipment-identifier: type: string description: CLEI or other specification for p-interface hardware. interface-role: type: string description: Role specification for p-interface hardware. interface-type: type: string description: Indicates the physical properties of the interface. prov-status: type: string description: Trigger for operational monitoring of this resource by Service Assurance systems. mac-addresss: type: string description: MAC Address of the p-interface. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. in-maint: type: boolean description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) inv-status: type: string description: inventory status network-ref: type: string description: Store the network-ref of this p-interface. Derived from ietf-restconf-notification that identifies a termination-point. transparent: type: string description: Store the transparent value of this p-interface. operational-status: type: string description: oper Status of this p-interface. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' sriov-pfs: type: array items: $ref: '#/components/schemas/sriov-pf' description: '' l-interfaces: type: array items: $ref: '#/components/schemas/l-interface' description: '' description: >- Physical interface (e.g., nic) ###### Related Nodes - 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 allotted-resource( allotted-resource Uses p-interface, ONE2MANY) AAI-1925 For CCVPN Usecase - 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 p-interfaces: title: p-interfaces type: object properties: p-interface: type: array items: $ref: '#/components/schemas/p-interface' description: '' description: Collection of physical interfaces. physical-link: title: physical-link required: - link-name type: object properties: link-name: type: string description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ speed-value: type: string description: Captures the numeric part of the speed speed-units: type: string description: Captures the units corresponding to the speed circuit-id: type: string description: Circuit it dual-mode: type: string description: Dual access mode (e.g., primary, secondary management-option: type: string description: To provide information on who manages this circuit. A&AI or 3rd party transport provider service-provider-name: type: string description: Name of the service Provider on this link. service-provider-bandwidth-up-value: type: integer description: Upstream Bandwidth value agreed with the service provider format: int32 service-provider-bandwidth-up-units: type: string description: Units for the upstream BW value service-provider-bandwidth-down-value: type: integer description: Downstream Bandwidth value agreed with the service provider format: int32 service-provider-bandwidth-down-units: type: string description: Units for downstream BW value resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Collection of physical connections, typically between p-interfaces ###### Related Nodes - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3) -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also physical-links: title: physical-links type: object properties: physical-link: type: array items: $ref: '#/components/schemas/physical-link' description: '' description: Collection of physical connections, typically between p-interfaces platform: title: platform required: - platform-name type: object properties: platform-name: type: string description: Name of the platform resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- describes a platform ###### Related Nodes - TO generic-vnf( platform Uses generic-vnf, MANY2MANY) - TO l3-network( platform Uses l3-network, MANY2MANY) platforms: title: platforms type: object properties: platform: type: array items: $ref: '#/components/schemas/platform' description: '' description: Collection of platforms pnf: title: pnf required: - pnf-name - in-maint type: object properties: pnf-name: type: string description: unique name of Physical Network Function. pnf-name2: type: string description: name of Physical Network Function. selflink: type: string description: URL to endpoint where AAI can get more details. pnf-name2-source: type: string description: source of name2 pnf-id: type: string description: id of pnf equip-type: type: string description: Equipment type. Source of truth should define valid values. equip-vendor: type: string description: Equipment vendor. Source of truth should define valid values. equip-model: type: string description: Equipment model. Source of truth should define valid values. management-option: type: string description: identifier of managed customer orchestration-status: type: string description: Orchestration status of this pnf ipaddress-v4-oam: type: string description: ipv4-oam-address with new naming convention for IP addresses sw-version: type: string description: sw-version is the version of SW for the hosted application on the PNF. in-maint: type: boolean description: 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: type: string description: ID of the physical frame (relay rack) where pnf is installed. serial-number: type: string description: Serial number of the device ipaddress-v4-loopback-0: type: string description: IPV4 Loopback 0 address ipaddress-v6-loopback-0: type: string description: IPV6 Loopback 0 address ipaddress-v4-aim: type: string description: IPV4 AIM address ipaddress-v6-aim: type: string description: IPV6 AIM address ipaddress-v6-oam: type: string description: IPV6 OAM address inv-status: type: string description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. prov-status: type: string description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV] nf-role: type: string description: Nf Role is the role performed by this instance in the network. admin-status: type: string description: admin Status of this PNF operational-status: type: string description: Store the operational-status for this object. model-customization-id: type: string description: Store the model-customization-id for this object. model-invariant-id: type: string description: The ASDC model id for this resource model. model-version-id: type: string description: The ASDC model version for this resource model. pnf-ipv4-address: type: string description: 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: type: string description: 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: type: array items: $ref: '#/components/schemas/software-version' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' p-interfaces: type: array items: $ref: '#/components/schemas/p-interface' description: '' lag-interfaces: type: array items: $ref: '#/components/schemas/lag-interface' description: '' vrfs: type: array items: $ref: '#/components/schemas/vrf' description: '' description: >- 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. ###### Related Nodes - 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 metadatum( metadatum AppliesTo pnf, MANY2MANY) AAI-2154 For BBS Usecase - 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) - FROM vrf (CHILD of pnf, vrf BelongsTo pnf, MANY2ONE) A vrf belongs to a pnf.(1) -(1) IF this PNF node is deleted, this FROM node is DELETED also -(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 pnfs: title: pnfs type: object properties: pnf: type: array items: $ref: '#/components/schemas/pnf' description: '' description: Collection of Physical Network Functions. port-group: title: port-group required: - interface-id - orchestration-status type: object properties: interface-id: type: string description: Unique ID of the interface neutron-network-id: type: string description: Neutron network id of this Interface neutron-network-name: type: string description: Neutron network name of this Interface interface-role: type: string description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. port-group-id: type: string description: Unique ID for port group in vmware port-group-name: type: string description: Likely to duplicate value of neutron network name switch-name: type: string description: DVS or standard switch name (should be non-null for port groups associated with DVS) orchestration-status: type: string description: Orchestration status of this VNF, mastered by MSO heat-stack-id: type: string description: Heat stack id corresponding to this instance, managed by MSO mso-catalog-key: type: string description: Corresponds to the SDN-C catalog id used to configure this VCE cvlan-tags: type: array items: $ref: '#/components/schemas/cvlan-tag-entry' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Used to capture the network interfaces of this VCE ###### Related Nodes - 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 port-groups: title: port-groups type: object properties: port-group: type: array items: $ref: '#/components/schemas/port-group' description: '' project: title: project required: - project-name type: object properties: project-name: type: string description: Name of the project deploying a service resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- describes the project ###### Related Nodes - TO service-instance( project Uses service-instance, ONE2MANY) projects: title: projects type: object properties: project: type: array items: $ref: '#/components/schemas/project' description: '' description: Collection of projects properties: title: properties type: object properties: property-name: type: string property-value: type: string description: Property holder for query properties or instance properties property-constraint: title: property-constraint required: - property-constraint-uuid - constraint-type - property-name - property-value type: object properties: property-constraint-uuid: type: string constraint-type: type: string property-name: type: string property-value: type: string resource-version: type: string description: >- TBD ###### Related Nodes - 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-constraints: title: property-constraints type: object properties: property-constraint: type: array items: $ref: '#/components/schemas/property-constraint' description: '' pserver: title: pserver required: - hostname - in-maint type: object properties: hostname: type: string description: Value from executing hostname on the compute node. ptnii-equip-name: type: string description: PTNII name number-of-cpus: type: integer description: Number of cpus format: int32 disk-in-gigabytes: type: integer description: Disk size, in GBs format: int32 ram-in-megabytes: type: integer description: RAM size, in MBs format: int32 equip-type: type: string description: Equipment type. Source of truth should define valid values. equip-vendor: type: string description: Equipment vendor. Source of truth should define valid values. equip-model: type: string description: Equipment model. Source of truth should define valid values. fqdn: type: string description: Fully-qualified domain name pserver-selflink: type: string description: URL to endpoint where AAI can get more details ipv4-oam-address: type: string description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device. serial-number: type: string description: Serial number, may be queried ipaddress-v4-loopback-0: type: string description: IPV4 Loopback 0 address ipaddress-v6-loopback-0: type: string description: IPV6 Loopback 0 address ipaddress-v4-aim: type: string description: IPV4 AIM address ipaddress-v6-aim: type: string description: IPV6 AIM address ipaddress-v6-oam: type: string description: IPV6 OAM address inv-status: type: string description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. pserver-id: type: string description: ID of Pserver internet-topology: type: string description: internet topology of Pserver in-maint: type: boolean description: 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: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. pserver-name2: type: string description: alternative pserver name purpose: type: string description: purpose of pserver prov-status: type: string description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV] management-option: type: string description: Indicates who owns and or manages the device. host-profile: type: string description: The host profile that defines the configuration of the pserver. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' p-interfaces: type: array items: $ref: '#/components/schemas/p-interface' description: '' lag-interfaces: type: array items: $ref: '#/components/schemas/lag-interface' description: '' hpa-capacity: type: array items: $ref: '#/components/schemas/hpa-capacity' description: '' description: >- Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver. ###### Related Nodes - 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 pservers: title: pservers type: object properties: pserver: type: array items: $ref: '#/components/schemas/pserver' description: '' description: Collection of compute hosts. query-parameters: title: query-parameters type: object properties: named-query: allOf: - $ref: '#/components/schemas/named-query' - description: >- TBD ###### Related Nodes - 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 overloaded-model: allOf: - $ref: '#/components/schemas/overloaded-model' - description: Allows for legacy POST of old-style and new-style models description: QueryParameters for performing a named-query or model query related-lookup: title: related-lookup required: - related-lookup-uuid - source-node-type - source-node-property - target-node-type - target-node-property type: object properties: related-lookup-uuid: type: string source-node-type: type: string source-node-property: type: string target-node-type: type: string target-node-property: type: string property-collect-list: type: string resource-version: type: string relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- TBD ###### Related Nodes - TO named-query-element (PARENT of related-lookup, related-lookup BelongsTo named-query-element, MANY2ONE)(4) -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also related-lookups: title: related-lookups type: object properties: related-lookup: type: array items: $ref: '#/components/schemas/related-lookup' description: '' related-to-property: title: related-to-property type: object properties: property-key: type: string description: Key part of a key/value pair property-value: type: string description: Value part of a key/value pair relationship: title: relationship type: object properties: relationship: type: array items: $ref: '#/components/schemas/relationship-dict' description: '' description: dictionary of relationship relationship-data: title: relationship-data required: - relationship-key - relationship-value type: object properties: relationship-key: type: string description: A keyword provided by A&AI to indicate an attribute. relationship-value: type: string description: Value of the attribute. relationship-dict: title: relationship-dict type: object properties: related-to: type: string description: A keyword provided by A&AI to indicate type of node. relationship-label: type: string description: The edge label for this relationship. related-link: type: string description: URL to the object in A&AI. relationship-data: type: array items: $ref: '#/components/schemas/relationship-data' description: '' relationship-list: title: relationship-list type: object properties: relationship: type: array items: $ref: '#/components/schemas/relationship' description: '' reserved-prop-names: title: reserved-prop-names type: object properties: last-mod-source-of-truth: type: string aai-node-type: type: string aai-created-ts: type: integer format: int64 aai-unique-key: type: string aai-last-mod-ts: type: integer format: int64 source-of-truth: type: string aai-uri: type: string description: Internal map to define some reserved properties of a vertex response-list: title: response-list type: object properties: inventory-response-items: allOf: - $ref: '#/components/schemas/inventory-response-items' - description: Container for inventory items in response list description: Response container for the results of a named-query or model query result-data: title: result-data type: object properties: resource-type: type: string description: The specific type of node in the A&AI graph resource-link: type: string description: The URL to the specific resource route-table-reference: title: route-table-reference required: - route-table-reference-id - route-table-reference-fqdn type: object properties: route-table-reference-id: type: string description: Route Table Reference id, UUID assigned to this instance. route-table-reference-fqdn: type: string description: FQDN entry in the route table. resource-version: type: string description: Concurrency value relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Openstack route table reference. ###### Related Nodes - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY) route-table-references: title: route-table-references type: object properties: route-table-reference: type: array items: $ref: '#/components/schemas/route-table-reference' description: '' description: Collection of openstack route table references route-target: title: route-target required: - global-route-target - route-target-role type: object properties: global-route-target: type: string description: Number used to identify an RT, globally unique in the network route-target-role: type: string description: Role assigned to this route target resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Route target information ###### Related Nodes - TO vpn-binding (PARENT of route-target, route-target BelongsTo vpn-binding, MANY2ONE)(4) - TO vrf (PARENT of route-target, route-target BelongsTo vrf, MANY2ONE)(4) -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also route-targets: title: route-targets type: object properties: route-target: type: array items: $ref: '#/components/schemas/route-target' description: '' description: Collection of route target information routing-instance: title: routing-instance required: - routing-instance-id type: object properties: routing-instance-id: type: string description: Unique id of routing instance rpm-owner: type: string description: rpm owner resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. site-pairs: type: array items: $ref: '#/components/schemas/site-pair' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- ###### Related Nodes - 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-instances: title: routing-instances type: object properties: routing-instance: type: array items: $ref: '#/components/schemas/routing-instance' description: '' description: set of probes related to generic-vnf routing instance sdn-zone-response: title: sdn-zone-response type: object properties: oam-networks: allOf: - $ref: '#/components/schemas/oam-networks' - description: Collection of OAM networks, to be deprecated shortly. Do not use for new purposes. az-and-dvs-switches: type: array items: $ref: '#/components/schemas/az-and-dvs-switches' description: '' sdwan-vpn: title: sdwan-vpn required: - sdwan-vpn-id type: object properties: sdwan-vpn-id: type: string description: Uniquely identifies this sdwan-vpn by id sdwan-vpn-name: type: string description: Store the name of this sdwan-vpn. vxlan-id: type: string description: Store the vxlan-id of this sdwan-vpn. topology: type: string description: Store the topology of this sdwan-vpn. tenant-id: type: string description: Store the tenant-id of this sdwan-vpn. vpn-id: type: string description: Store the vpn-id of this sdwan-vpn. selflink: type: string description: Store the link to get more information for this object. operational-status: type: string description: Store the operational-status for this object. model-customization-id: type: string description: Store the model-customization-id for this object. model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Instance of an sdwan-vpn ###### Related Nodes - 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-vpns: title: sdwan-vpns type: object properties: sdwan-vpn: type: array items: $ref: '#/components/schemas/sdwan-vpn' description: '' description: Collection of sdwan-vpns search: title: search type: object properties: edge-tag-query-result: $ref: '#/components/schemas/edge-tag-query-result' edge-tag-query-request: $ref: '#/components/schemas/edge-tag-query-request' search-results: $ref: '#/components/schemas/search-results' sdn-zone-response: $ref: '#/components/schemas/sdn-zone-response' search-results: title: search-results type: object properties: result-data: type: array items: $ref: '#/components/schemas/result-data' description: '' secondary-filter: title: secondary-filter type: object properties: property-name: type: string filter-type: type: string property-value: type: string secondary-filts: title: secondary-filts type: object properties: secondary-filt: type: array items: type: object description: '' description: SecondaryFilts for performing a named-query or model query segmentation-assignment: title: segmentation-assignment required: - segmentation-id type: object properties: segmentation-id: type: string description: Route Table Reference id, UUID assigned to this instance. resource-version: type: string description: Concurrency value relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Openstack segmentation assignment. ###### Related Nodes - 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-assignments: title: segmentation-assignments type: object properties: segmentation-assignment: type: array items: $ref: '#/components/schemas/segmentation-assignment' description: '' description: Collection of openstack segmentation assignments service: title: service required: - service-id - service-description type: object properties: service-id: type: string description: This gets defined by others to provide a unique ID for the service, we accept what is sent. service-description: type: string description: Description of the service service-selflink: type: string description: URL to endpoint where AAI can get more details resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. service-version: type: string description: service version relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services. service-capabilities: title: service-capabilities type: object properties: service-capability: type: array items: $ref: '#/components/schemas/service-capability' description: '' description: Collection of service capabilities. service-capability: title: service-capability required: - service-type - vnf-type type: object properties: service-type: type: string description: This gets defined by others to provide a unique ID for the service, we accept what is sent. vnf-type: type: string description: String capturing type of vnf, that was intended to identify the SDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ONAP matures. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this. ###### Related Nodes - 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-design-and-creation: title: service-design-and-creation type: object properties: vnf-images: type: array items: $ref: '#/components/schemas/vnf-image' description: '' services: type: array items: $ref: '#/components/schemas/service' description: '' service-capabilities: type: array items: $ref: '#/components/schemas/service-capability' description: '' models: type: array items: $ref: '#/components/schemas/model' description: '' named-queries: type: array items: $ref: '#/components/schemas/named-query' description: '' description: Namespace for objects managed by ASDC service-instance: title: service-instance required: - service-instance-id type: object properties: service-instance-id: type: string description: Uniquely identifies this instance of a service service-instance-name: type: string description: This field will store a name assigned to the service-instance. service-type: type: string description: String capturing type of service. service-role: type: string description: String capturing the service role. environment-context: type: string description: This field will store the environment context assigned to the service-instance. workload-context: type: string description: This field will store the workload context assigned to the service-instance. created-at: type: string description: create time of Network Service. updated-at: type: string description: last update of Network Service. description: type: string description: short description for service-instance. model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. persona-model-version: type: string description: the ASDC model version for this resource or service model. widget-model-id: type: string description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. widget-model-version: type: string description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. bandwidth-total: type: string description: Indicates the total bandwidth to be used for this service. vhn-portal-url: type: string description: URL customers will use to access the vHN Portal. service-instance-location-id: type: string description: An identifier that customers assign to the location where this service is being used. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. selflink: type: string description: Path to the controller object. orchestration-status: type: string description: Orchestration status of this service. input-parameters: type: string description: String capturing request parameters from SO to pass to Closed Loop. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' metadata: type: array items: $ref: '#/components/schemas/metadatum' description: '' allotted-resources: type: array items: $ref: '#/components/schemas/allotted-resource' description: '' description: >- Instance of a service ###### Related Nodes - 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 Uses instance-group, ONE2MANY) MSO creates this edge on VNF Group Service creation - TO instance-group( service-instance MemberOf instance-group, MANY2MANY) - TO l3-network( service-instance ComposedOf l3-network, 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, ONE2MANY) 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-instances: title: service-instances type: object properties: service-instance: type: array items: $ref: '#/components/schemas/service-instance' description: '' description: Collection of service instances service-subscription: title: service-subscription required: - service-type type: object properties: service-type: type: string description: Value defined by orchestration to identify this service across ONAP. temp-ub-sub-account-id: type: string description: This property will be deleted from A&AI in the near future. Only stop gap solution. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. service-instances: type: array items: $ref: '#/components/schemas/service-instance' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Object that group service instances. ###### Related Nodes - 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-subscriptions: title: service-subscriptions type: object properties: service-subscription: type: array items: $ref: '#/components/schemas/service-subscription' description: '' description: Collection of objects that group service instances. services: title: services type: object properties: service: type: array items: $ref: '#/components/schemas/service' description: '' description: Collection of service model definitions. Likely to be deprecated in favor of models from ASDC. site-pair: title: site-pair required: - site-pair-id type: object properties: site-pair-id: type: string description: unique identifier of probe source-ip: type: string description: Prefix address destination-ip: type: string description: Prefix address ip-version: type: string description: ip version, v4, v6 destination-hostname: type: string description: Hostname of the destination equipment to which SLAs are measured against. destination-equip-type: type: string description: The type of destinatination equipment. Could be Router, UCPE, etc. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. classes-of-service: type: array items: $ref: '#/components/schemas/class-of-service' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- ###### Related Nodes - 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-set: title: site-pair-set required: - site-pair-set-id type: object properties: site-pair-set-id: type: string description: Unique id of site pair set. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. routing-instances: type: array items: $ref: '#/components/schemas/routing-instance' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Set of instances for probes used to measure service level agreements ###### Related Nodes - 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-sets: title: site-pair-sets type: object properties: site-pair-set: type: array items: $ref: '#/components/schemas/site-pair-set' description: '' description: Collection of sets of instances for probes related to generic-vnf site-pairs: title: site-pairs type: object properties: site-pair: type: array items: $ref: '#/components/schemas/site-pair' description: '' description: probe within a set site-resource: title: site-resource required: - site-resource-id type: object properties: site-resource-id: type: string description: Uniquely identifies this site-resource by id site-resource-name: type: string description: Store the name of this site-resource. description: type: string description: Store the description of this site-resource. type: type: string description: Store the type of this site-resource. role: type: string description: Store the role of this site-resource. generated-site-id: type: string description: Store the generated-site-id of this site-resource. selflink: type: string description: Store the link to get more information for this object. operational-status: type: string description: Store the operational-status for this object. model-customization-id: type: string description: Store the model-customization-id for this object. model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Instance of a site-resource ###### Related Nodes - 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-resources: title: site-resources type: object properties: site-resource: type: array items: $ref: '#/components/schemas/site-resource' description: '' description: Collection of site-resources snapshot: title: snapshot required: - snapshot-id type: object properties: snapshot-id: type: string description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. snapshot-name: type: string description: Snapshot name snapshot-architecture: type: string description: Operating system architecture snapshot-os-distro: type: string description: The common name of the operating system distribution in lowercase snapshot-os-version: type: string description: The operating system version as specified by the distributor. application: type: string description: The application that the image instantiates. application-vendor: type: string description: The vendor of the application. application-version: type: string description: The version of the application. snapshot-selflink: type: string description: URL to endpoint where AAI can get more details prev-snapshot-id: type: string description: This field contains the UUID of the previous snapshot (if any). resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Openstack snapshot ###### Related Nodes - TO cloud-region (PARENT of snapshot, snapshot BelongsTo cloud-region, MANY2ONE) - FROM vserver( vserver Uses snapshot, ONE2ONE) snapshots: title: snapshots type: object properties: snapshot: type: array items: $ref: '#/components/schemas/snapshot' description: '' description: Collection of openstack snapshots software-version: title: software-version required: - software-version-id - is-active-sw-ver type: object properties: software-version-id: type: string description: Identifier of the software version is-active-sw-ver: type: boolean description: used to indicate whether or not this software-version is the active one (activeSw = true) description: >- Software Version ###### Related Nodes - TO pnf (PARENT of software-version, software-version BelongsTo pnf, MANY2ONE) software-versions: title: software-versions type: object properties: software-version: type: array items: $ref: '#/components/schemas/software-version' description: '' description: Collection of software versions. sp-partner: title: sp-partner required: - sp-partner-id type: object properties: sp-partner-id: type: string description: Uniquely identifies this sp-partner by id url: type: string description: Store the URL of this sp-partner. callsource: type: string description: Store the callsource of this sp-partner. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. operational-status: type: string description: Store the operational-status for this sp-partner. model-customization-id: type: string description: Store the model-customization-id for this sp-partner. model-invariant-id: type: string description: the ASDC model id for this sp-partner model. model-version-id: type: string description: the ASDC model version for this sp-partner model. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Instance of an sp-partner ###### Related Nodes - TO service-instance( sp-partner PartOf service-instance, ONE2MANY) For CCVPN Usecase sp-partners: title: sp-partners type: object properties: sp-partner: type: array items: $ref: '#/components/schemas/sp-partner' description: '' description: Collection of sp-partners sriov-pf: title: sriov-pf required: - pf-pci-id type: object properties: pf-pci-id: type: string description: Identifier for the sriov-pf resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- SR-IOV Physical Function ###### Related Nodes - 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 sriov-pfs: title: sriov-pfs type: object properties: sriov-pf: type: array items: $ref: '#/components/schemas/sriov-pf' description: '' description: Collection of SR-IOV Physical Functions. sriov-vf: title: sriov-vf required: - pci-id type: object properties: pci-id: type: string description: PCI ID used to identify the sriov-vf vf-vlan-filter: type: string description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. vf-mac-filter: type: string description: 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: type: boolean description: 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: type: boolean description: 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: type: boolean description: 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: type: string description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports. vf-broadcast-allow: type: boolean description: 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: type: boolean description: 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: type: boolean description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM vf-insert-stag: type: boolean description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM. vf-link-status: type: string description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. neutron-network-id: type: string description: Neutron network id of the interface relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- SR-IOV Virtual Function (not to be confused with virtual network function) ###### Related Nodes - 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 sriov-vfs: title: sriov-vfs type: object properties: sriov-vf: type: array items: $ref: '#/components/schemas/sriov-vf' description: '' description: Collection of SR-IOV Virtual Functions. start-node-filter: title: start-node-filter type: object properties: property-name: type: string property-value: type: string subnet: title: subnet required: - subnet-id - dhcp-enabled type: object properties: subnet-id: type: string description: Subnet ID, should be UUID. subnet-name: type: string description: Name associated with the subnet. neutron-subnet-id: type: string description: Neutron id of this subnet gateway-address: type: string description: gateway ip address network-start-address: type: string description: network start address cidr-mask: type: string description: cidr mask ip-version: type: string description: ip version orchestration-status: type: string description: Orchestration status of this VNF, mastered by MSO dhcp-enabled: type: boolean description: dhcp enabled dhcp-start: type: string description: the start address reserved for use by dhcp dhcp-end: type: string description: the last address reserved for use by dhcp subnet-role: type: string description: role of the subnet, referenced when assigning IPs ip-assignment-direction: type: string description: ip address assignment direction of the subnet resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. subnet-sequence: type: integer description: sequence of the subnet format: int32 host-routes: type: array items: $ref: '#/components/schemas/host-route' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- ###### Related Nodes - 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 subnets: title: subnets type: object properties: subnet: type: array items: $ref: '#/components/schemas/subnet' description: '' tagged-inventory-item-list: title: tagged-inventory-item-list type: object properties: inventory-item: type: array items: $ref: '#/components/schemas/inventory-item' description: '' tenant: title: tenant required: - tenant-id - tenant-name type: object properties: tenant-id: type: string description: Unique id relative to the cloud-region. tenant-name: type: string description: Readable name of tenant tenant-context: type: string description: This field will store the tenant context. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. vservers: type: array items: $ref: '#/components/schemas/vserver' description: '' nos-servers: type: array items: $ref: '#/components/schemas/nos-server' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Openstack tenant ###### Related Nodes - TO cloud-region (PARENT of tenant, tenant BelongsTo cloud-region, MANY2ONE) - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY) - TO l3-network( tenant Uses l3-network, MANY2MANY) - TO volume-group( tenant DependsOn volume-group, ONE2MANY) - FROM generic-vnf( generic-vnf BelongsTo tenant, MANY2ONE) - FROM 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 tenants: title: tenants type: object properties: tenant: type: array items: $ref: '#/components/schemas/tenant' description: '' description: Collection of openstack tenants. tunnel-xconnect: title: tunnel-xconnect required: - id type: object properties: id: type: string description: Allotted Resource id UUID assigned to this instance. resource-version: type: string description: Concurrency value relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted ###### Related Nodes - 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 tunnel-xconnects: title: tunnel-xconnects type: object properties: tunnel-xconnect: type: array items: $ref: '#/components/schemas/tunnel-xconnect' description: '' description: This object is used to store the specific tunnel cross connect aspects of an allotted resource update: title: update required: - update-node-type type: object properties: update-node-type: type: string update-node-key: type: array items: $ref: '#/components/schemas/update-node-key' description: '' update-node-uri: type: string action: type: array items: $ref: '#/components/schemas/action' description: '' description: Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team. update-node-key: title: update-node-key type: object properties: key-name: type: string key-value: type: string vce: title: vce required: - vnf-id - vnf-name - vnf-type type: object properties: vnf-id: type: string description: Unique id of VNF. This is unique across the graph. vnf-name: type: string description: Name of VNF. vnf-name2: type: string description: Alternate name of VNF. vnf-type: type: string description: String capturing type of vnf, that was intended to identify the SDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ONAP matures. service-id: type: string description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. regional-resource-zone: type: string description: Regional way of organizing pservers, source of truth should define values prov-status: type: string description: Trigger for operational monitoring of this resource by Service Assurance systems. operational-status: type: string description: Indicator for whether the resource is considered operational license-key: type: string description: OBSOLETE - do not use equipment-role: type: string description: Network role being played by this VNF orchestration-status: type: string description: Orchestration status of this VNF, mastered by MSO heat-stack-id: type: string description: Heat stack id corresponding to this instance, managed by MSO mso-catalog-key: type: string description: Corresponds to the SDN-C catalog id used to configure this VCE vpe-id: type: string description: Unique ID of VPE connected to this VCE. v6-vce-wan-address: type: string description: Valid v6 IP address for the WAN Link on this router. Implied length of /64. ipv4-oam-address: type: string description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. ipv4-loopback0-address: type: string description: Loopback0 address entitlement-resource-uuid: type: string description: OBSOLETE - see child relationships port-groups: type: array items: $ref: '#/components/schemas/port-group' description: '' licenses: type: array items: $ref: '#/components/schemas/license' description: '' entitlements: type: array items: $ref: '#/components/schemas/entitlement' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated. ###### Related Nodes - 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 vces: title: vces type: object properties: vce: type: array items: $ref: '#/components/schemas/vce' description: '' description: Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated. vf-module: title: vf-module required: - vf-module-id - is-base-vf-module - automated-assignment type: object properties: vf-module-id: type: string description: Unique ID of vf-module. vf-module-name: type: string description: Name of vf-module heat-stack-id: type: string description: Heat stack id corresponding to this instance. orchestration-status: type: string description: orchestration status of this vf-module, mastered by MSO is-base-vf-module: type: boolean description: used to indicate whether or not this object is base vf module automated-assignment: type: boolean description: Indicates whether vf-module assignment was done via automation or manually resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. persona-model-version: type: string description: the ASDC model version for this resource or service model. model-customization-id: type: string description: captures the id of all the configuration used to customize the resource for the service. widget-model-id: type: string description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. widget-model-version: type: string description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. contrail-service-instance-fqdn: type: string description: the Contrail unique ID for a service-instance module-index: type: integer description: 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 format: int32 selflink: type: string description: Path to the controller object. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- a deployment unit of VNFCs ###### Related Nodes - 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-modules: title: vf-modules type: object properties: vf-module: type: array items: $ref: '#/components/schemas/vf-module' description: '' description: Collection of vf-modules, a deployment unit of VNFCs vig-server: title: vig-server required: - vig-address-type type: object properties: vig-address-type: type: string description: indicates whether the VIG is for AVPN or INTERNET ipaddress-v4-vig: type: string description: v4 IP of the vig server ipaddress-v6-vig: type: string description: v6 IP of the vig server resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607 ###### Related Nodes - 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-servers: title: vig-servers type: object properties: vig-server: type: array items: $ref: '#/components/schemas/vig-server' description: '' vip-ipv4-address-list: title: vip-ipv4-address-list required: - vip-ipv4-address type: object properties: vip-ipv4-address: type: string description: IP address vip-ipv4-prefix-length: type: integer description: Prefix length, 32 for single address format: int64 vlan-id-inner: type: integer description: Inner VLAN tag format: int64 vlan-id-outer: type: integer description: Outer VLAN tag format: int64 is-floating: type: boolean description: Indicator of fixed or floating address resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. neutron-network-id: type: string description: Neutron network id of the interface that address belongs to neutron-subnet-id: type: string description: Neutron id of subnet that address belongs to relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- IPv4 Address Range ###### Related Nodes - 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-ipv6-address-list: title: vip-ipv6-address-list required: - vip-ipv6-address type: object properties: vip-ipv6-address: type: string description: IP address vip-ipv6-prefix-length: type: integer description: Prefix length, 128 for single address format: int64 vlan-id-inner: type: integer description: Inner VLAN tag format: int64 vlan-id-outer: type: integer description: Outer VLAN tag format: int64 is-floating: type: boolean description: Indicator of fixed or floating address resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. neutron-network-id: type: string description: Neutron network id of the interface that address belongs to neutron-subnet-id: type: string description: Neutron id of subnet that address belongs to relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- IPv6 Address Range ###### Related Nodes - 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) virtual-data-center: title: virtual-data-center required: - vdc-id - vdc-name type: object properties: vdc-id: type: string description: Unique ID of the vdc vdc-name: type: string description: Name of the virtual data center resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Virtual organization of cloud infrastructure elements in a data center context ###### Related Nodes - 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) virtual-data-centers: title: virtual-data-centers type: object properties: virtual-data-center: type: array items: $ref: '#/components/schemas/virtual-data-center' description: '' description: Virtual organization of cloud infrastructure elements in a data center context vlan: title: vlan required: - vlan-interface - in-maint - is-ip-unnumbered type: object properties: vlan-interface: type: string description: String that identifies the interface vlan-id-inner: type: integer description: Inner VLAN tag format: int64 vlan-id-outer: type: integer description: Outer VLAN tag format: int64 resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. speed-value: type: string description: Captures the numeric part of the speed speed-units: type: string description: Captures the units corresponding to the speed vlan-description: type: string description: Used to describe (the service associated with) the vlan backdoor-connection: type: string description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device. vpn-key: type: string description: This indicates the customers VPN ID associated with this vlan orchestration-status: type: string description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C. in-maint: type: boolean description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) prov-status: type: string description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV]. is-ip-unnumbered: type: boolean description: Flag indicating the interface uses the IP Unnumbered configuration. is-private: type: boolean description: Private VLAN indicator. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' l3-interface-ipv4-address-list: type: array items: $ref: '#/components/schemas/l3-interface-ipv4-address-list' description: '' l3-interface-ipv6-address-list: type: array items: $ref: '#/components/schemas/l3-interface-ipv6-address-list' description: '' description: >- Definition of vlan ###### Related Nodes - 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-mapping: title: vlan-mapping required: - vlan-mapping-id type: object properties: vlan-mapping-id: type: string description: Key for vlan-mapping object. uni-cvlan: type: string description: CVLAN value from the UNI/ingress side of the SAREA gateway access device. nni-svlan: type: string description: SVLAN value from the NNI/egress side of the SAREA gateway access device. nni-cvlan: type: string description: CVLAN value from the NNI/egress side of the SAREA gateway access device. ivlan: type: string description: The internal VLAN ('IVLAN') value. Specific to Arista devices. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' resource-version: type: string description: >- vlan-mapping object is an optional child object of the forwarder-evc object. A given forwarder-evc object may have multiple vlan-mapping objects. ###### Related Nodes - 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-mappings: title: vlan-mappings type: object properties: vlan-mapping: type: array items: $ref: '#/components/schemas/vlan-mapping' description: '' description: Collection of vlan mappings. vlan-tag: title: vlan-tag required: - vlan-tag-id - vlan-tag-role - vlan-id-outer - is-private type: object properties: vlan-tag-id: type: string description: Unique ID of the vlan-tag vlan-tag-role: type: string description: purpose (l3-network to be connected to) vlan-id-inner: type: integer description: VLAN inner id format: int32 vlan-id-outer: type: integer description: VLAN outer id format: int32 is-private: type: boolean description: is VLAN private? resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- ###### Related Nodes - 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-tags: title: vlan-tags type: object properties: vlan-tag: type: array items: $ref: '#/components/schemas/vlan-tag' description: '' vlans: title: vlans type: object properties: vlan: type: array items: $ref: '#/components/schemas/vlan' description: '' vnf: title: vnf required: - vnf-id type: object properties: vnf-id: type: string description: Unique id of VNF. This is unique across the graph. description: Abstract vnf class vnf-image: title: vnf-image required: - vnf-image-uuid - application - application-vendor type: object properties: vnf-image-uuid: type: string description: Unique ID of this asset application: type: string description: The application that the image instantiates. application-vendor: type: string description: The vendor of the application. application-version: type: string description: The version of the application. selflink: type: string description: URL to endpoint where AAI can get more details resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge. ###### Related Nodes - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE) -VNF-IMAGE cannot be deleted if related to GENERIC-VNF vnf-images: title: vnf-images type: object properties: vnf-image: type: array items: $ref: '#/components/schemas/vnf-image' description: '' description: Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge. vnfc: title: vnfc required: - vnfc-name - nfc-naming-code - nfc-function - in-maint - is-closed-loop-disabled type: object properties: vnfc-name: type: string description: Unique ID of vnfc. nfc-naming-code: type: string description: Short code that is used in naming instances of the item being modeled nfc-function: type: string description: 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: type: string description: prov status of this vnfc orchestration-status: type: string description: Orchestration status of this VNF, mastered by APP-C ipaddress-v4-oam-vip: type: string description: Oam V4 vip address of this vnfc in-maint: type: boolean description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) is-closed-loop-disabled: type: boolean description: used to indicate whether closed loop function is enabled on this node group-notation: type: string description: Group notation of VNFC model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. model-customization-id: type: string description: captures the id of all the configuration used to customize the resource for the service. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' cps: type: array items: $ref: '#/components/schemas/cp' description: '' l3-interface-ipv4-address-list: type: array items: $ref: '#/components/schemas/l3-interface-ipv4-address-list' description: '' l3-interface-ipv6-address-list: type: array items: $ref: '#/components/schemas/l3-interface-ipv6-address-list' description: '' description: >- ###### Related Nodes - 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 vnfcs: title: vnfcs type: object properties: vnfc: type: array items: $ref: '#/components/schemas/vnfc' description: '' description: virtual network components associated with a vserver from application controller. volume: title: volume required: - volume-id - volume-selflink type: object properties: volume-id: type: string description: Unique ID of block storage volume relative to the vserver. volume-selflink: type: string description: URL to endpoint where AAI can get more details resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Ephemeral Block storage volume. ###### Related Nodes - FROM vserver (PARENT of volume, vserver AttachesTo volume, ONE2MANY)(3) -(3) IF this FROM node is deleted, this VOLUME is DELETED also volume-group: title: volume-group required: - volume-group-id - vnf-type type: object properties: volume-group-id: type: string description: Unique ID of volume-group. volume-group-name: type: string description: Name of the volume group. heat-stack-id: type: string description: Heat stack id corresponding to this volume-group vnf-type: type: string description: String capturing type of vnf, that was intended to identify the SDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ONAP matures. orchestration-status: type: string description: Orchestration status of this volume-group model-customization-id: type: string description: captures the id of all the configuration used to customize the resource for the service. vf-module-model-customization-id: type: string description: helps relate the volume group to the vf-module whose components will require the volume group resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Persistent block-level storage. ###### Related Nodes - 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-groups: title: volume-groups type: object properties: volume-group: type: array items: $ref: '#/components/schemas/volume-group' description: '' description: Collection of persistent block-level storage. volumes: title: volumes type: object properties: volume: type: array items: $ref: '#/components/schemas/volume' description: '' description: Collection of ephemeral Block storage volumes. vpls-pe: title: vpls-pe required: - equipment-name type: object properties: equipment-name: type: string prov-status: type: string description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. ipv4-oam-address: type: string description: 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: type: string description: Client should send valid enumerated value, e.g., VPLS-PE. vlan-id-outer: type: integer description: Temporary location for stag to get to VCE format: int64 resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' p-interfaces: type: array items: $ref: '#/components/schemas/p-interface' description: '' lag-interfaces: type: array items: $ref: '#/components/schemas/lag-interface' description: '' description: >- VPLS Provider Edge routers. ###### Related Nodes - 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 vpls-pes: title: vpls-pes type: object properties: vpls-pe: type: array items: $ref: '#/components/schemas/vpls-pe' description: '' description: Collection of VPLS Provider Edge routers vpn-binding: title: vpn-binding required: - vpn-id - vpn-name type: object properties: vpn-id: type: string description: VPN ID, globally unique within A&AI vpn-name: type: string description: VPN Name vpn-platform: type: string description: the platform associated with the VPN example AVPN, Mobility vpn-type: type: string description: Type of the vpn, should be taken from enumerated/valid values vpn-region: type: string description: region of customer vpn customer-vpn-id: type: string description: id for this customer vpn route-distinguisher: type: string description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network. access-provider-id: type: string description: Store the id of the access provider of this vpn. access-client-id: type: string description: Store the id of the access client of this vpn. access-topology-id: type: string description: Store the id of the access topology of this vpn. src-access-node-id: type: string description: Store the id of the src-access-node of this vpn. src-access-ltp-id: type: string description: Store the id of the src-access-ltp of this vpn. dst-access-node-id: type: string description: Store the id of the dst-access-node of this vpn. dst-access-ltp-id: type: string description: Store the id of the dst-access-ltp of this vpn. operational-status: type: string description: Store the operational-status for this object. model-customization-id: type: string description: Store the model-customization-id for this object. model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. route-targets: type: array items: $ref: '#/components/schemas/route-target' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: l3-networks relate to vpn-bindings description: >- VPN binding ###### Related Nodes - 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 - FROM vrf( vrf AppliesTo vpn-binding, MANY2ONE) A vrf uses a vpn-binding. -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also -(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-bindings: title: vpn-bindings type: object properties: vpn-binding: type: array items: $ref: '#/components/schemas/vpn-binding' description: '' vrf: title: vrf required: - vrf-id - vrf-name type: object properties: vrf-id: type: string description: VRF UUID. vrf-name: type: string description: VRF Name vrf-description: type: string description: VRF Description route-distinguisher: type: string description: Route Distinguisher vrf-type: type: string description: The type of vrf (bridge-domain as an example) vrf-address-family: type: string description: IP address family (v6/v4/both) resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. route-targets: type: array items: $ref: '#/components/schemas/route-target' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Definition of vrf ###### Related Nodes - TO l-interface( vrf Uses l-interface, ONE2MANY) - TO l3-network( vrf Uses l3-network, ONE2MANY) A vrf uses many l3-networks - TO pnf (PARENT of vrf, vrf BelongsTo pnf, MANY2ONE) A vrf belongs to a pnf.(4) - TO vpn-binding( vrf AppliesTo vpn-binding, MANY2ONE) A vrf uses a vpn-binding. - FROM configuration( configuration Uses vrf, ONE2MANY) A Configuration uses VRFs - FROM route-target (CHILD of vrf, route-target BelongsTo vrf, MANY2ONE)(1) -(1) IF this VRF node is deleted, this FROM node is DELETED also -(4) IF this TO node is deleted, this VRF is DELETED also vrfs: title: vrfs type: object properties: vrf: type: array items: $ref: '#/components/schemas/vrf' description: '' vserver: title: vserver required: - vserver-id - vserver-name - vserver-selflink - in-maint - is-closed-loop-disabled type: object properties: vserver-id: type: string description: Unique identifier for this vserver relative to its tenant vserver-name: type: string description: Name of vserver vserver-name2: type: string description: Alternative name of vserver prov-status: type: string description: Trigger for operational monitoring of this resource by Service Assurance systems. vserver-selflink: type: string description: URL to endpoint where AAI can get more details in-maint: type: boolean description: 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: type: boolean description: Used to indicate whether closed loop function is enabled on this node resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. volumes: type: array items: $ref: '#/components/schemas/volume' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' l-interfaces: type: array items: $ref: '#/components/schemas/l-interface' description: '' description: >- Virtual Servers, aka virtual machine or VM. ###### Related Nodes - 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 vservers: title: vservers type: object properties: vserver: type: array items: $ref: '#/components/schemas/vserver' description: '' description: Collection of virtual Servers, aka virtual machines or VMs. wan-port-config: title: wan-port-config required: - wan-port-config-id type: object properties: wan-port-config-id: type: string description: Uniquely identifies this wan-port-config by id wan-port-config-name: type: string description: Store the name of this wan-port-config. device-id: type: string description: Store the id of the device of this wan-port-config. vlan-id: type: string description: Store the id of the vlan of this wan-port-config. ip-address: type: string description: Store the ip-address of this wan-port-config. ipv4-address: type: string description: Store the ipv4-address of this wan-port-config. ipv6-address: type: string description: Store the ipv6-address of this wan-port-config. provider-ip-address: type: string description: Store the provider-ip-address of this wan-port-config. provider-ipv4-address: type: string description: Store the provider-ipv4-address of this wan-port-config. provider-ipv6-address: type: string description: Store the provider-ipv6-address of this wan-port-config. input-bandwidth: type: string description: Store the input-bandwidth of this wan-port-config. output-bandwidth: type: string description: Store the output-bandwidth of this wan-port-config. description: type: string description: Store the description of this wan-port-config. port-type: type: string description: Store the port-type of this wan-port-config. port-number: type: string description: Store the port-number of this wan-port-config. transport-network-name: type: string description: Store the transport-network-name of this wan-port-config. device-port-id: type: string description: Store the device-port-id of this wan-port-config. wan-port-id: type: string description: Store the wan-port-id of this wan-port-config. selflink: type: string description: Store the link to get more information for this object. operational-status: type: string description: Store the operational-status for this object. model-customization-id: type: string description: Store the model-customization-id for this object. model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- Instance of a wan-port-config ###### Related Nodes - 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, ONE2MANY) For CCVPN Usecase -(2) IF this WAN-PORT-CONFIG node is deleted, this TO node is DELETED also wan-port-configs: title: wan-port-configs type: object properties: wan-port-config: type: array items: $ref: '#/components/schemas/wan-port-config' description: '' description: Collection of wan-port-configs zone: title: zone required: - zone-id - zone-name - design-type - zone-context - in-maint type: object properties: zone-id: type: string description: Code assigned by AIC to the zone zone-name: type: string description: English name associated with the zone design-type: type: string description: Design of zone [Medium/Large…] zone-context: type: string description: Context of zone [production/test] status: type: string description: Status of a zone. resource-version: type: string description: Concurrency value in-maint: type: boolean description: Used to indicate whether or not zone object is in maintenance mode. relationship-list: type: array items: $ref: '#/components/schemas/relationship' description: '' description: >- A zone is a grouping of assets in a location homing to the same connections into the CBB ###### Related Nodes - 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) zones: title: zones type: object properties: zone: type: array items: $ref: '#/components/schemas/zone' description: '' description: Collection of zones aggregate-route1: title: aggregate-route1 required: - route-id - network-start-address - cidr-mask - ip-version type: object properties: route-id: type: string description: Unique id of the aggregate-route instance network-start-address: type: string description: Name of the forwarding-path cidr-mask: type: string description: CIDR-mask for aggregate route subnet ip-version: type: string description: Identifies is aggregate route is ipv4 or ipv6 resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: "Aggregate route configs are used on the D2 IPE’s for the Voice services. In 1902, SDNC will create aggregate-route objects and write them to A&AI. \n###### Related Nodes\n- TO l3-network (PARENT of aggregate-route, aggregate-route BelongsTo l3-network, MANY2ONE)(4)\n\n-(4) IF this TO node is deleted, this AGGREGATE-ROUTE is DELETED also" aggregate-route2: title: aggregate-route2 required: - route-id - network-start-address - cidr-mask - ip-version type: object properties: route-id: type: string description: Unique id of the aggregate-route instance network-start-address: type: string description: Name of the forwarding-path cidr-mask: type: string description: CIDR-mask for aggregate route subnet ip-version: type: string description: Identifies is aggregate route is ipv4 or ipv6 description: "Aggregate route configs are used on the D2 IPE’s for the Voice services. In 1902, SDNC will create aggregate-route objects and write them to A&AI. \n###### Related Nodes\n- TO l3-network (PARENT of aggregate-route, aggregate-route BelongsTo l3-network, MANY2ONE)(4)\n\n-(4) IF this TO node is deleted, this AGGREGATE-ROUTE is DELETED also" aggregate-routes1: title: aggregate-routes1 type: object properties: aggregate-route: type: array items: $ref: '#/components/schemas/aggregate-route1' description: '' description: Collection of aggregate routes. allotted-resource1: title: allotted-resource1 required: - id type: object properties: id: type: string description: Allotted Resource id UUID assigned to this instance. description: type: string description: The descriptive information assigned to this allotted resource instance selflink: type: string description: Link back to more information in the controller model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. resource-version: type: string description: Concurrency value orchestration-status: type: string description: Orchestration status operational-status: type: string description: Indicator for whether the resource is considered operational type: type: string description: Generic description of the type of allotted resource. role: type: string description: role in the network that this resource will be providing. allotted-resource-name: type: string description: Store the name of this allotted-resource. access-provider-id: type: string description: Store the id of the access provider of this allotted-resource. access-client-id: type: string description: Store the id of the access client of this allotted-resource. access-topology-id: type: string description: Store the id of the access topology of this allotted-resource. access-node-id: type: string description: Store the id of the access node of this allotted-resource. access-ltp-id: type: string description: Store the id of the access ltp of this allotted-resource. cvlan: type: string description: Store the cvlan of this allotted-resource. vpn-name: type: string description: Store the vpn-name of this allotted-resource. tunnel-xconnects: type: array items: $ref: '#/components/schemas/tunnel-xconnect1' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Represents a slice or partial piece of a resource that gets separately allotted ###### Related Nodes - TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE) AAI-1925 - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY) - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY) - TO l-interface( allotted-resource Uses l-interface, ONE2MANY) - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY) - TO network-policy( allotted-resource Uses network-policy, ONE2ONE) - TO p-interface( allotted-resource Uses p-interface, ONE2MANY) AAI-1925 For CCVPN Usecase - TO service-instance (PARENT of allotted-resource, allotted-resource BelongsTo service-instance, MANY2ONE)(4) - TO vlan( allotted-resource PartOf vlan, MANY2MANY) - TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY) - FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE) AAI-1925 - FROM configuration( configuration Uses allotted-resource, 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 allotted-resource2: title: allotted-resource2 required: - id type: object properties: id: type: string description: Allotted Resource id UUID assigned to this instance. description: type: string description: The descriptive information assigned to this allotted resource instance selflink: type: string description: Link back to more information in the controller model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. description: >- Represents a slice or partial piece of a resource that gets separately allotted ###### Related Nodes - TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE) AAI-1925 - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY) - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY) - TO l-interface( allotted-resource Uses l-interface, ONE2MANY) - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY) - TO network-policy( allotted-resource Uses network-policy, ONE2ONE) - TO p-interface( allotted-resource Uses p-interface, ONE2MANY) AAI-1925 For CCVPN Usecase - TO service-instance (PARENT of allotted-resource, allotted-resource BelongsTo service-instance, MANY2ONE)(4) - TO vlan( allotted-resource PartOf vlan, MANY2MANY) - TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY) - FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE) AAI-1925 - FROM configuration( configuration Uses allotted-resource, 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 allotted-resources1: title: allotted-resources1 type: object properties: allotted-resource: type: array items: $ref: '#/components/schemas/allotted-resource1' description: '' description: This object is used to store slices of services being offered availability-zone1: title: availability-zone1 required: - availability-zone-name - hypervisor-type type: object properties: availability-zone-name: type: string description: Name of the availability zone. Unique across a cloud region hypervisor-type: type: string description: Type of hypervisor. Source of truth should define valid values. operational-status: type: string description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Availability zone, a collection of compute hosts/pservers ###### Related Nodes - 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-zone2: title: availability-zone2 required: - availability-zone-name - hypervisor-type type: object properties: availability-zone-name: type: string description: Name of the availability zone. Unique across a cloud region hypervisor-type: type: string description: Type of hypervisor. Source of truth should define valid values. operational-status: type: string description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values. description: >- Availability zone, a collection of compute hosts/pservers ###### Related Nodes - 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-zones1: title: availability-zones1 type: object properties: availability-zone: type: array items: $ref: '#/components/schemas/availability-zone1' description: '' description: Collection of availability zones classes-of-service1: title: classes-of-service1 type: object properties: class-of-service: type: array items: $ref: '#/components/schemas/class-of-service1' description: '' description: class-of-service of probe class-of-service1: title: class-of-service1 required: - cos type: object properties: cos: type: string description: unique identifier of probe probe-id: type: string description: identifier of probe probe-type: type: string description: type of probe resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- ###### Related Nodes - 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 class-of-service2: title: class-of-service2 required: - cos type: object properties: cos: type: string description: unique identifier of probe probe-id: type: string description: identifier of probe probe-type: type: string description: type of probe description: >- ###### Related Nodes - 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 cloud-region1: title: cloud-region1 required: - cloud-owner - cloud-region-id - orchestration-disabled - in-maint type: object properties: cloud-owner: type: string description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname cloud-region-id: type: string description: Identifier used by the vendor for the region. Second part of composite key cloud-type: type: string description: Type of the cloud (e.g., openstack) owner-defined-type: type: string description: Cloud-owner defined type indicator (e.g., dcp, lcp) cloud-region-version: type: string description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE. identity-url: type: string description: URL of the keystone identity service cloud-zone: type: string description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. complex-name: type: string description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. sriov-automation: type: string description: Whether the cloud region supports (true) or does not support (false) SR-IOV automation. cloud-extra-info: type: string description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM. upgrade-cycle: type: string description: Upgrade cycle for the cloud region. For AIC regions upgrade cycle is designated by A,B,C etc. orchestration-disabled: type: boolean description: Used to indicate whether orchestration is enabled for this cloud-region. in-maint: type: boolean description: Used to indicate whether or not cloud-region object is in maintenance mode. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. volume-groups: type: array items: $ref: '#/components/schemas/volume-group1' description: '' tenants: type: array items: $ref: '#/components/schemas/tenant1' description: '' flavors: type: array items: $ref: '#/components/schemas/flavor1' description: '' group-assignments: type: array items: $ref: '#/components/schemas/group-assignment1' description: '' snapshots: type: array items: $ref: '#/components/schemas/snapshot1' description: '' images: type: array items: $ref: '#/components/schemas/image1' description: '' dvs-switches: type: array items: $ref: '#/components/schemas/dvs-switch1' description: '' oam-networks: type: array items: $ref: '#/components/schemas/oam-network1' description: '' availability-zones: type: array items: $ref: '#/components/schemas/availability-zone1' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' vip-ipv4-address-list: type: array items: $ref: '#/components/schemas/vip-ipv4-address-list1' description: '' vip-ipv6-address-list: type: array items: $ref: '#/components/schemas/vip-ipv6-address-list1' description: '' hpa-capabilities: type: array items: $ref: '#/components/schemas/hpa-capability1' description: List of cloud-region specific HPA Capabilities esr-system-info-list: type: array items: $ref: '#/components/schemas/esr-system-info1' description: '' description: >- 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. ###### Related Nodes - 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 generic-vnf( generic-vnf LocatedIn 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-region2: title: cloud-region2 required: - cloud-owner - cloud-region-id - orchestration-disabled - in-maint type: object properties: cloud-owner: type: string description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname cloud-region-id: type: string description: Identifier used by the vendor for the region. Second part of composite key cloud-type: type: string description: Type of the cloud (e.g., openstack) owner-defined-type: type: string description: Cloud-owner defined type indicator (e.g., dcp, lcp) cloud-region-version: type: string description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE. identity-url: type: string description: URL of the keystone identity service cloud-zone: type: string description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. complex-name: type: string description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED. sriov-automation: type: string description: Whether the cloud region supports (true) or does not support (false) SR-IOV automation. cloud-extra-info: type: string description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM. upgrade-cycle: type: string description: Upgrade cycle for the cloud region. For AIC regions upgrade cycle is designated by A,B,C etc. orchestration-disabled: type: boolean description: Used to indicate whether orchestration is enabled for this cloud-region. in-maint: type: boolean description: Used to indicate whether or not cloud-region object is in maintenance mode. description: >- 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. ###### Related Nodes - 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 generic-vnf( generic-vnf LocatedIn 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-regions1: title: cloud-regions1 type: object properties: cloud-region: type: array items: $ref: '#/components/schemas/cloud-region1' description: '' collection1: title: collection1 required: - collection-id type: object properties: collection-id: type: string description: Collection Object UUID model-invariant-id: type: string description: ASDC model id for this resource or service model model-version-id: type: string description: Model Version collection-name: type: string description: collection name collection-type: type: string description: Collection type collection-role: type: string description: Collection Role collection-function: type: string description: Collection function orchestration-status: type: string description: orchestration status collection-customization-id: type: string description: Captures the id of all the configuration used to customize the resource for the service relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. description: >- represents the collection resource in the TOSCA model ###### Related Nodes - FROM instance-group( instance-group BelongsTo collection, ONE2ONE) - FROM service-instance( service-instance ComposedOf collection, ONE2ONE) collection2: title: collection2 required: - collection-id type: object properties: collection-id: type: string description: Collection Object UUID model-invariant-id: type: string description: ASDC model id for this resource or service model model-version-id: type: string description: Model Version collection-name: type: string description: collection name collection-type: type: string description: Collection type collection-role: type: string description: Collection Role collection-function: type: string description: Collection function orchestration-status: type: string description: orchestration status collection-customization-id: type: string description: Captures the id of all the configuration used to customize the resource for the service description: >- represents the collection resource in the TOSCA model ###### Related Nodes - FROM instance-group( instance-group BelongsTo collection, ONE2ONE) - FROM service-instance( service-instance ComposedOf collection, ONE2ONE) collections1: title: collections1 type: object properties: collection: type: array items: $ref: '#/components/schemas/collection1' description: '' complex1: title: complex1 required: - physical-location-id - physical-location-type - street1 - city - postal-code - country - region type: object properties: physical-location-id: type: string description: Unique identifier for physical location, e.g., CLLI data-center-code: type: string description: Data center code which can be an alternate way to identify a complex complex-name: type: string description: Gamma complex name for LCP instance. identity-url: type: string description: URL of the keystone identity service resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. physical-location-type: type: string description: Type, e.g., central office, data center. street1: type: string street2: type: string city: type: string state: type: string postal-code: type: string country: type: string region: type: string latitude: type: string longitude: type: string elevation: type: string lata: type: string ctag-pools: type: array items: $ref: '#/components/schemas/ctag-pool1' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Collection of physical locations that can house cloud-regions. ###### Related Nodes - 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 complex2: title: complex2 required: - physical-location-id type: object properties: physical-location-id: type: string description: Unique identifier for physical location, e.g., CLLI data-center-code: type: string description: Data center code which can be an alternate way to identify a complex complex-name: type: string description: Gamma complex name for LCP instance. identity-url: type: string description: URL of the keystone identity service description: >- Collection of physical locations that can house cloud-regions. ###### Related Nodes - 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 complexes1: title: complexes1 type: object properties: complex: type: array items: $ref: '#/components/schemas/complex1' description: '' description: Collection of physical locations that can house cloud-regions. configuration1: title: configuration1 required: - configuration-id - configuration-type type: object properties: configuration-id: type: string description: UUID assigned to configuration. management-option: type: string description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well. configuration-name: type: string description: Name of the configuration. configuration-type: type: string description: port-mirroring-configuration. configuration-sub-type: type: string description: vprobe, pprobe. model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. orchestration-status: type: string description: Orchestration status of the configuration. operational-status: type: string description: Indicator for whether the resource is considered operational. configuration-selflink: type: string description: URL to endpoint where AAI can get more details from SDN-GC. model-customization-id: type: string description: id of the configuration used to customize the resource tunnel-bandwidth: type: string description: DHV Site Effective Bandwidth vendor-allowed-max-bandwidth: type: string description: Velocloud Nominal Throughput - VNT config-policy-name: type: string description: 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: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' metadata: type: array items: $ref: '#/components/schemas/metadatum' description: '' forwarder-evcs: type: array items: $ref: '#/components/schemas/forwarder-evc1' description: '' evcs: type: array items: $ref: '#/components/schemas/evc1' description: '' description: >- Generic configuration object. ###### Related Nodes - 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, MANY2MANY) - 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) - TO vrf( configuration Uses vrf, ONE2MANY) A Configuration uses VRFs - FROM configuration( configuration BindsTo configuration, ONE2ONE) - FROM evc (CHILD of configuration, evc BelongsTo configuration, ONE2ONE)(1) - FROM forwarder( forwarder Uses configuration, ONE2ONE)(3) - FROM forwarder-evc (CHILD of configuration, forwarder-evc BelongsTo configuration, ONE2ONE)(1) - FROM forwarding-path( forwarding-path Uses configuration, ONE2ONE)(3) - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3) - FROM metadatum (CHILD of configuration, metadatum BelongsTo configuration, MANY2ONE)(1) - FROM service-instance( service-instance Uses configuration, ONE2MANY) - FROM service-instance( service-instance ComposedOf configuration, MANY2MANY) -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also -(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 configuration2: title: configuration2 required: - configuration-id - configuration-type type: object properties: configuration-id: type: string description: UUID assigned to configuration. management-option: type: string description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well. configuration-name: type: string description: Name of the configuration. configuration-type: type: string description: port-mirroring-configuration. configuration-sub-type: type: string description: vprobe, pprobe. model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. orchestration-status: type: string description: Orchestration status of the configuration. operational-status: type: string description: Indicator for whether the resource is considered operational. configuration-selflink: type: string description: URL to endpoint where AAI can get more details from SDN-GC. model-customization-id: type: string description: id of the configuration used to customize the resource tunnel-bandwidth: type: string description: DHV Site Effective Bandwidth vendor-allowed-max-bandwidth: type: string description: Velocloud Nominal Throughput - VNT config-policy-name: type: string description: Used to capture the name of the fabric configuration policy that was used to generate the payload sent to PINC for fabric configuration. description: >- Generic configuration object. ###### Related Nodes - 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, MANY2MANY) - 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) - TO vrf( configuration Uses vrf, ONE2MANY) A Configuration uses VRFs - FROM configuration( configuration BindsTo configuration, ONE2ONE) - FROM evc (CHILD of configuration, evc BelongsTo configuration, ONE2ONE)(1) - FROM forwarder( forwarder Uses configuration, ONE2ONE)(3) - FROM forwarder-evc (CHILD of configuration, forwarder-evc BelongsTo configuration, ONE2ONE)(1) - FROM forwarding-path( forwarding-path Uses configuration, ONE2ONE)(3) - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3) - FROM metadatum (CHILD of configuration, metadatum BelongsTo configuration, MANY2ONE)(1) - FROM service-instance( service-instance Uses configuration, ONE2MANY) - FROM service-instance( service-instance ComposedOf configuration, MANY2MANY) -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also -(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 configurations1: title: configurations1 type: object properties: configuration: type: array items: $ref: '#/components/schemas/configuration1' description: '' description: Collection of configurations connectivities1: title: connectivities1 type: object properties: connectivity: type: array items: $ref: '#/components/schemas/connectivity1' description: '' description: Collection of connectivities connectivity1: title: connectivity1 required: - connectivity-id type: object properties: connectivity-id: type: string description: Uniquely identifies this connectivity by id bandwidth-profile-name: type: string description: Store the name of a bandwidth profile. vpn-type: type: string description: Store the type of a bandwidth profile. cir: type: string description: Store the CIR of this connectivity. eir: type: string description: Store the EIR of this connectivity. cbs: type: string description: Store the CBS of this connectivity. ebs: type: string description: Store the EBS of this connectivity. color-aware: type: string description: Store the color-awareness of this connectivity. coupling-flag: type: string description: Store the coupling flag of this connectivity. etht-svc-name: type: string description: The ethernet service name for this connectivity. access-provider-id: type: string description: Store the id of the access provider of this connectivity. access-client-id: type: string description: Store the id of the access client of this connectivity. access-topology-id: type: string description: Store the id of the access topology of this connectivity. access-node-id: type: string description: Store the id of the access node of this connectivity. access-ltp-id: type: string description: Store the id of the access ltp of this connectivity. connectivity-selflink: type: string description: Store the link to get more information for this connectivity. cvlan: type: string description: Store the cvlan for this connectivity. operational-status: type: string description: Store the operational-status for this object. model-customization-id: type: string description: Store the model-customization-id for this object. model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Instance of a connectivity ###### Related Nodes - 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 connectivity2: title: connectivity2 required: - connectivity-id type: object properties: connectivity-id: type: string description: Uniquely identifies this connectivity by id bandwidth-profile-name: type: string description: Store the name of a bandwidth profile. vpn-type: type: string description: Store the type of a bandwidth profile. cir: type: string description: Store the CIR of this connectivity. eir: type: string description: Store the EIR of this connectivity. cbs: type: string description: Store the CBS of this connectivity. ebs: type: string description: Store the EBS of this connectivity. color-aware: type: string description: Store the color-awareness of this connectivity. coupling-flag: type: string description: Store the coupling flag of this connectivity. etht-svc-name: type: string description: The ethernet service name for this connectivity. access-provider-id: type: string description: Store the id of the access provider of this connectivity. access-client-id: type: string description: Store the id of the access client of this connectivity. access-topology-id: type: string description: Store the id of the access topology of this connectivity. access-node-id: type: string description: Store the id of the access node of this connectivity. access-ltp-id: type: string description: Store the id of the access ltp of this connectivity. connectivity-selflink: type: string description: Store the link to get more information for this connectivity. cvlan: type: string description: Store the cvlan for this connectivity. operational-status: type: string description: Store the operational-status for this object. model-customization-id: type: string description: Store the model-customization-id for this object. model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. description: >- Instance of a connectivity ###### Related Nodes - 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 connector1: title: connector1 required: - resource-instance-id type: object properties: resource-instance-id: type: string description: Unique id of resource instance. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. widget-model-id: type: string description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. widget-model-version: type: string description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' metadata: type: array items: $ref: '#/components/schemas/metadatum' description: '' description: >- Collection of resource instances used to connect a variety of disparate inventory widgets ###### Related Nodes - 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 connector2: title: connector2 required: - resource-instance-id type: object properties: resource-instance-id: type: string description: Unique id of resource instance. description: >- Collection of resource instances used to connect a variety of disparate inventory widgets ###### Related Nodes - 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 connectors1: title: connectors1 type: object properties: connector: type: array items: $ref: '#/components/schemas/connector1' description: '' description: Collection of resource instances used to connect a variety of disparate inventory widgets constrained-element-set1: title: constrained-element-set1 required: - constrained-element-set-uuid - constraint-type - check-type type: object properties: constrained-element-set-uuid: type: string constraint-type: type: string check-type: type: string resource-version: type: string element-choice-sets: type: array items: $ref: '#/components/schemas/element-choice-set1' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- This is how we would capture constraints defining allowed sets of elements. ###### Related Nodes - 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-set2: title: constrained-element-set2 required: - constrained-element-set-uuid - constraint-type - check-type type: object properties: constrained-element-set-uuid: type: string constraint-type: type: string check-type: type: string description: >- This is how we would capture constraints defining allowed sets of elements. ###### Related Nodes - 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-sets1: title: constrained-element-sets1 type: object properties: constrained-element-set: type: array items: $ref: '#/components/schemas/constrained-element-set1' description: '' contact1: title: contact1 required: - contact-name type: object properties: contact-name: type: string description: Name of the contact contact-telephone: type: string description: Tel no. of contact contact-email: type: string description: e-mail of contact vendor-type: type: string description: NI (Network Integrator)SI (System Integrator) 3rd Party LCM resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Contacts store the vendor information and have a relationship to the generic-vnf. In 1902, this will be populated by SDN-GC ###### Related Nodes - TO generic-vnf( contact supports generic-vnf, MANY2MANY) contact2: title: contact2 required: - contact-name type: object properties: contact-name: type: string description: Name of the contact contact-telephone: type: string description: Tel no. of contact contact-email: type: string description: e-mail of contact vendor-type: type: string description: NI (Network Integrator)SI (System Integrator) 3rd Party LCM description: >- Contacts store the vendor information and have a relationship to the generic-vnf. In 1902, this will be populated by SDN-GC ###### Related Nodes - TO generic-vnf( contact supports generic-vnf, MANY2MANY) contacts1: title: contacts1 type: object properties: contact: type: array items: $ref: '#/components/schemas/contact1' description: '' description: Collection of contacts cp1: title: cp1 required: - cp-instance-id type: object properties: cp-instance-id: type: string description: Unique ID of the connection point. port-id: type: integer description: port index to represent multiple CPs on VNFC connected to same network. format: int32 resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' l3-interface-ipv4-address-list: type: array items: $ref: '#/components/schemas/l3-interface-ipv4-address-list1' description: '' l3-interface-ipv6-address-list: type: array items: $ref: '#/components/schemas/l3-interface-ipv6-address-list1' description: '' description: >- point of attachment from services or resources to a virtual link or network. ###### Related Nodes - FROM l-interface( l-interface LinksTo cp, ONE2ONE) - FROM l3-interface-ipv4-address-list (CHILD of cp, l3-interface-ipv4-address-list BelongsTo cp, MANY2ONE)(1) - FROM l3-interface-ipv6-address-list (CHILD of cp, l3-interface-ipv6-address-list BelongsTo cp, MANY2ONE)(1) - FROM l3-network( l3-network LinksTo cp, MANY2MANY) - FROM metadatum( metadatum AppliesTo cp, MANY2MANY) AAI-2154 For BBS Usecase - FROM vip-ipv4-address-list( vip-ipv4-address-list Uses cp, MANY2MANY) - FROM vip-ipv6-address-list( vip-ipv6-address-list Uses cp, MANY2MANY) - FROM vlan-tag( vlan-tag Uses cp, MANY2MANY) - FROM vnfc (PARENT of cp, vnfc BelongsTo cp, ONE2MANY) cp is child of vnfc(3) -(1) IF this CP node is deleted, this FROM node is DELETED also -(3) IF this FROM node is deleted, this CP is DELETED also cp2: title: cp2 required: - cp-instance-id type: object properties: cp-instance-id: type: string description: Unique ID of the connection point. port-id: type: integer description: port index to represent multiple CPs on VNFC connected to same network. format: int32 description: >- point of attachment from services or resources to a virtual link or network. ###### Related Nodes - FROM l-interface( l-interface LinksTo cp, ONE2ONE) - FROM l3-interface-ipv4-address-list (CHILD of cp, l3-interface-ipv4-address-list BelongsTo cp, MANY2ONE)(1) - FROM l3-interface-ipv6-address-list (CHILD of cp, l3-interface-ipv6-address-list BelongsTo cp, MANY2ONE)(1) - FROM l3-network( l3-network LinksTo cp, MANY2MANY) - FROM metadatum( metadatum AppliesTo cp, MANY2MANY) AAI-2154 For BBS Usecase - FROM vip-ipv4-address-list( vip-ipv4-address-list Uses cp, MANY2MANY) - FROM vip-ipv6-address-list( vip-ipv6-address-list Uses cp, MANY2MANY) - FROM vlan-tag( vlan-tag Uses cp, MANY2MANY) - FROM vnfc (PARENT of cp, vnfc BelongsTo cp, ONE2MANY) cp is child of vnfc(3) -(1) IF this CP node is deleted, this FROM node is DELETED also -(3) IF this FROM node is deleted, this CP is DELETED also cps1: title: cps1 type: object properties: cp: type: array items: $ref: '#/components/schemas/cp1' description: '' description: Collection of connection points. ctag-assignment1: title: ctag-assignment1 required: - vlan-id-inner type: object properties: vlan-id-inner: type: integer description: id. format: int64 resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- ###### Related Nodes - 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 ctag-assignment2: title: ctag-assignment2 required: - vlan-id-inner type: object properties: vlan-id-inner: type: integer description: id. format: int64 description: >- ###### Related Nodes - 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 ctag-assignments1: title: ctag-assignments1 type: object properties: ctag-assignment: type: array items: $ref: '#/components/schemas/ctag-assignment1' description: '' ctag-pool1: title: ctag-pool1 required: - target-pe - availability-zone-name - ctag-pool-purpose type: object properties: target-pe: type: string description: The Target provider edge router availability-zone-name: type: string description: Name of the availability zone ctag-pool-purpose: type: string description: Describes what the intended purpose of this pool is. ctag-values: type: string description: Comma separated list of ctags resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- A collection of C tags (vlan tags) grouped for a specific purpose. ###### Related Nodes - 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 ctag-pool2: title: ctag-pool2 required: - target-pe - availability-zone-name - ctag-pool-purpose type: object properties: target-pe: type: string description: The Target provider edge router availability-zone-name: type: string description: Name of the availability zone ctag-pool-purpose: type: string description: Describes what the intended purpose of this pool is. ctag-values: type: string description: Comma separated list of ctags description: >- A collection of C tags (vlan tags) grouped for a specific purpose. ###### Related Nodes - 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 ctag-pools1: title: ctag-pools1 type: object properties: ctag-pool: type: array items: $ref: '#/components/schemas/ctag-pool1' description: '' customer1: title: customer1 required: - global-customer-id - subscriber-name - subscriber-type type: object properties: global-customer-id: type: string description: Global customer id used across ONAP to uniquely identify customer. subscriber-name: type: string description: Subscriber name, an alternate way to retrieve a customer. subscriber-type: type: string description: Subscriber type, a way to provide VID with only the INFRA customers. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. service-subscriptions: type: array items: $ref: '#/components/schemas/service-subscription1' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- customer identifiers to provide linkage back to BSS information. ###### Related Nodes - 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 customer2: title: customer2 required: - global-customer-id - subscriber-name - subscriber-type type: object properties: global-customer-id: type: string description: Global customer id used across ONAP to uniquely identify customer. subscriber-name: type: string description: Subscriber name, an alternate way to retrieve a customer. subscriber-type: type: string description: Subscriber type, a way to provide VID with only the INFRA customers. description: >- customer identifiers to provide linkage back to BSS information. ###### Related Nodes - 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 customers1: title: customers1 type: object properties: customer: type: array items: $ref: '#/components/schemas/customer1' description: '' description: Collection of customer identifiers to provide linkage back to BSS information. cvlan-tag-entry1: title: cvlan-tag-entry1 required: - cvlan-tag type: object properties: cvlan-tag: type: integer description: See mis-na-virtualization-platform.yang format: int64 resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' cvlan-tag-entry2: title: cvlan-tag-entry2 required: - cvlan-tag type: object properties: cvlan-tag: type: integer description: See mis-na-virtualization-platform.yang format: int64 cvlan-tags1: title: cvlan-tags1 type: object properties: cvlan-tag-entry: type: array items: $ref: '#/components/schemas/cvlan-tag-entry1' description: '' device1: title: device1 required: - device-id type: object properties: device-id: type: string description: Uniquely identifies this device by id esn: type: string description: Store the esn of this device. device-name: type: string description: Store the name of this device. description: type: string description: Store the description of this device. vendor: type: string description: Store the vendor of this device. class: type: string description: Store the class of this device. type: type: string description: Store the type of this device. version: type: string description: Store the version of this device. system-ip: type: string description: Store the system-ip of this device. system-ipv4: type: string description: Store the system-ipv4 of this device. system-ipv6: type: string description: Store the system-ipv6 of this device. selflink: type: string description: Store the link to get more information for this object. operational-status: type: string description: Store the operational-status for this object. model-customization-id: type: string description: Store the model-customization-id for this object. model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Instance of a device ###### Related Nodes - 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 device2: title: device2 required: - device-id type: object properties: device-id: type: string description: Uniquely identifies this device by id esn: type: string description: Store the esn of this device. device-name: type: string description: Store the name of this device. description: type: string description: Store the description of this device. vendor: type: string description: Store the vendor of this device. class: type: string description: Store the class of this device. type: type: string description: Store the type of this device. version: type: string description: Store the version of this device. system-ip: type: string description: Store the system-ip of this device. system-ipv4: type: string description: Store the system-ipv4 of this device. system-ipv6: type: string description: Store the system-ipv6 of this device. selflink: type: string description: Store the link to get more information for this object. operational-status: type: string description: Store the operational-status for this object. model-customization-id: type: string description: Store the model-customization-id for this object. model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. description: >- Instance of a device ###### Related Nodes - 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 devices1: title: devices1 type: object properties: device: type: array items: $ref: '#/components/schemas/device1' description: '' description: Collection of devices dhcp-service1: title: dhcp-service1 required: - dhcp-service-id type: object properties: dhcp-service-id: type: string description: Uniquely identifies this dhcp-service by id server-ipv4-address: type: string description: Store the server-ip4-address of this dhcp-service. server-ipv6-address: type: string description: Store the server-ipv6-address of this dhcp-service. service-enable: type: string description: Store the service-enable of this dhcp-service. dhcp-service-type: type: string description: Store the dhcp-service-type of this dhcp-service. lease-time: type: string description: Store the lease-time of this dhcp-service. domain-name: type: string description: Store the domain-name of this dhcp-service. dns: type: string description: Store the dns of this dhcp-service. ntp-primary: type: string description: Store the ntp-primary of this dhcp-service. ntp-secondary: type: string description: Store the ntp-secondary of this dhcp-service. nbns: type: string description: Store the nbns of this dhcp-service. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Instance of a dhcp-service ###### Related Nodes - 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-service2: title: dhcp-service2 required: - dhcp-service-id type: object properties: dhcp-service-id: type: string description: Uniquely identifies this dhcp-service by id server-ipv4-address: type: string description: Store the server-ip4-address of this dhcp-service. server-ipv6-address: type: string description: Store the server-ipv6-address of this dhcp-service. service-enable: type: string description: Store the service-enable of this dhcp-service. dhcp-service-type: type: string description: Store the dhcp-service-type of this dhcp-service. lease-time: type: string description: Store the lease-time of this dhcp-service. domain-name: type: string description: Store the domain-name of this dhcp-service. dns: type: string description: Store the dns of this dhcp-service. ntp-primary: type: string description: Store the ntp-primary of this dhcp-service. ntp-secondary: type: string description: Store the ntp-secondary of this dhcp-service. nbns: type: string description: Store the nbns of this dhcp-service. description: >- Instance of a dhcp-service ###### Related Nodes - 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-services1: title: dhcp-services1 type: object properties: dhcp-service: type: array items: $ref: '#/components/schemas/dhcp-service1' description: '' description: Collection of dhcp-services dvs-switch1: title: dvs-switch1 required: - switch-name - vcenter-url type: object properties: switch-name: type: string description: DVS switch name vcenter-url: type: string description: URL used to reach the vcenter resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: "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. \n###### Related Nodes\n- TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)\n- TO cloud-region (PARENT of dvs-switch, dvs-switch BelongsTo cloud-region, MANY2ONE)" dvs-switch2: title: dvs-switch2 required: - switch-name - vcenter-url type: object properties: switch-name: type: string description: DVS switch name vcenter-url: type: string description: URL used to reach the vcenter description: "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. \n###### Related Nodes\n- TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)\n- TO cloud-region (PARENT of dvs-switch, dvs-switch BelongsTo cloud-region, MANY2ONE)" dvs-switches1: title: dvs-switches1 type: object properties: dvs-switch: type: array items: $ref: '#/components/schemas/dvs-switch1' description: '' description: Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs. element-choice-set1: title: element-choice-set1 required: - element-choice-set-uuid - element-choice-set-name type: object properties: element-choice-set-uuid: type: string element-choice-set-name: type: string cardinality: type: string resource-version: type: string model-elements: type: array items: $ref: '#/components/schemas/model-element1' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- This is how we would capture constraints defining allowed sets of elements. ###### Related Nodes - 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-set2: title: element-choice-set2 required: - element-choice-set-uuid - element-choice-set-name type: object properties: element-choice-set-uuid: type: string element-choice-set-name: type: string cardinality: type: string description: >- This is how we would capture constraints defining allowed sets of elements. ###### Related Nodes - 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-sets1: title: element-choice-sets1 type: object properties: element-choice-set: type: array items: $ref: '#/components/schemas/element-choice-set1' description: '' entitlement1: title: entitlement1 required: - group-uuid - resource-uuid type: object properties: group-uuid: type: string description: Unique ID for the entitlement group the resource comes from, should be uuid. resource-uuid: type: string description: Unique ID of an entitlement resource. resource-version: type: string description: Concurrency value relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Metadata for entitlement group. ###### Related Nodes - 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 entitlement2: title: entitlement2 required: - group-uuid - resource-uuid type: object properties: group-uuid: type: string description: Unique ID for the entitlement group the resource comes from, should be uuid. resource-uuid: type: string description: Unique ID of an entitlement resource. description: >- Metadata for entitlement group. ###### Related Nodes - 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 entitlements1: title: entitlements1 type: object properties: entitlement: type: array items: $ref: '#/components/schemas/entitlement1' description: '' description: Entitlements, keyed by group-uuid and resource-uuid, related to license management esr-ems1: title: esr-ems1 required: - ems-id type: object properties: ems-id: type: string description: Unique ID of EMS. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. esr-system-info-list: type: array items: $ref: '#/components/schemas/esr-system-info1' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Persist EMS address information used by EMS driver. ###### Related Nodes - 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 esr-ems2: title: esr-ems2 required: - ems-id type: object properties: ems-id: type: string description: Unique ID of EMS. description: >- Persist EMS address information used by EMS driver. ###### Related Nodes - 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 esr-ems-list1: title: esr-ems-list1 type: object properties: esr-ems: type: array items: $ref: '#/components/schemas/esr-ems1' description: '' esr-nfvo1: title: esr-nfvo1 required: - nfvo-id type: object properties: nfvo-id: type: string description: Unique ID of nfvo. api-root: type: string description: indecate the api-root. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. esr-system-info-list: type: array items: $ref: '#/components/schemas/esr-system-info1' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Persist NFVO address information used by VF-C. ###### Related Nodes - FROM esr-system-info (CHILD of esr-nfvo, esr-system-info BelongsTo esr-nfvo, ONE2ONE)(1) -(1) IF this ESR-NFVO node is deleted, this FROM node is DELETED also esr-nfvo2: title: esr-nfvo2 required: - nfvo-id type: object properties: nfvo-id: type: string description: Unique ID of nfvo. api-root: type: string description: indecate the api-root. description: >- Persist NFVO address information used by VF-C. ###### Related Nodes - FROM esr-system-info (CHILD of esr-nfvo, esr-system-info BelongsTo esr-nfvo, ONE2ONE)(1) -(1) IF this ESR-NFVO node is deleted, this FROM node is DELETED also esr-nfvo-list1: title: esr-nfvo-list1 type: object properties: esr-nfvo: type: array items: $ref: '#/components/schemas/esr-nfvo1' description: '' esr-system-info1: title: esr-system-info1 required: - esr-system-info-id - user-name - password - system-type type: object properties: esr-system-info-id: type: string description: Unique ID of esr system info. system-name: type: string description: name of external system. type: type: string description: type of external systems. vendor: type: string description: vendor of external systems. version: type: string description: version of external systems. service-url: type: string description: url used to access external systems. user-name: type: string description: username used to access external systems. password: type: string description: password used to access external systems. system-type: type: string description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm. protocol: type: string description: protocol of third party SDNC, for example netconf/snmp. ssl-cacert: type: string description: ca file content if enabled ssl on auth-url. ssl-insecure: type: boolean description: Whether to verify VIM's certificate. ip-address: type: string description: service IP of ftp server. port: type: string description: service port of ftp server. cloud-domain: type: string description: domain info for authentication. default-tenant: type: string description: default tenant of VIM. passive: type: boolean description: ftp passive mode or not. remote-path: type: string description: resource or performance data file path. system-status: type: string description: the status of external system. openstack-region-id: type: string description: OpenStack region ID used by MultiCloud plugin to interact with an OpenStack instance. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Persist common address information of external systems. ###### Related Nodes - TO cloud-region (PARENT of esr-system-info, esr-system-info BelongsTo cloud-region, MANY2ONE)(4) - TO esr-ems (PARENT of esr-system-info, esr-system-info BelongsTo esr-ems, MANY2ONE)(4) - TO esr-nfvo (PARENT of esr-system-info, esr-system-info BelongsTo esr-nfvo, ONE2ONE)(4) - TO esr-thirdparty-sdnc (PARENT of esr-system-info, esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4) - TO esr-vnfm (PARENT of esr-system-info, esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4) - FROM ext-aai-network (PARENT of esr-system-info, ext-aai-network Uses esr-system-info, ONE2MANY) For CCVPN Usecase(3) -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also -ESR-SYSTEM-INFO cannot be deleted if related to EXT-AAI-NETWORK esr-system-info2: title: esr-system-info2 required: - esr-system-info-id - user-name - password - system-type type: object properties: esr-system-info-id: type: string description: Unique ID of esr system info. system-name: type: string description: name of external system. type: type: string description: type of external systems. vendor: type: string description: vendor of external systems. version: type: string description: version of external systems. service-url: type: string description: url used to access external systems. user-name: type: string description: username used to access external systems. password: type: string description: password used to access external systems. system-type: type: string description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm. protocol: type: string description: protocol of third party SDNC, for example netconf/snmp. ssl-cacert: type: string description: ca file content if enabled ssl on auth-url. ssl-insecure: type: boolean description: Whether to verify VIM's certificate. ip-address: type: string description: service IP of ftp server. port: type: string description: service port of ftp server. cloud-domain: type: string description: domain info for authentication. default-tenant: type: string description: default tenant of VIM. passive: type: boolean description: ftp passive mode or not. remote-path: type: string description: resource or performance data file path. system-status: type: string description: the status of external system. openstack-region-id: type: string description: OpenStack region ID used by MultiCloud plugin to interact with an OpenStack instance. description: >- Persist common address information of external systems. ###### Related Nodes - TO cloud-region (PARENT of esr-system-info, esr-system-info BelongsTo cloud-region, MANY2ONE)(4) - TO esr-ems (PARENT of esr-system-info, esr-system-info BelongsTo esr-ems, MANY2ONE)(4) - TO esr-nfvo (PARENT of esr-system-info, esr-system-info BelongsTo esr-nfvo, ONE2ONE)(4) - TO esr-thirdparty-sdnc (PARENT of esr-system-info, esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4) - TO esr-vnfm (PARENT of esr-system-info, esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4) - FROM ext-aai-network (PARENT of esr-system-info, ext-aai-network Uses esr-system-info, ONE2MANY) For CCVPN Usecase(3) -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also -ESR-SYSTEM-INFO cannot be deleted if related to EXT-AAI-NETWORK esr-system-info-list1: title: esr-system-info-list1 type: object properties: esr-system-info: type: array items: $ref: '#/components/schemas/esr-system-info1' description: '' description: Collection of persistent block-level external system auth info. esr-thirdparty-sdnc1: title: esr-thirdparty-sdnc1 required: - thirdparty-sdnc-id type: object properties: thirdparty-sdnc-id: type: string description: Unique ID of SDNC. location: type: string description: used for DC type to indicate the location of SDNC, such as Core or Edge. product-name: type: string description: password used to access SDNC server. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. esr-system-info-list: type: array items: $ref: '#/components/schemas/esr-system-info1' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Persist SDNC address information used by ONAP SDNC. ###### Related Nodes - 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 esr-thirdparty-sdnc2: title: esr-thirdparty-sdnc2 required: - thirdparty-sdnc-id type: object properties: thirdparty-sdnc-id: type: string description: Unique ID of SDNC. location: type: string description: used for DC type to indicate the location of SDNC, such as Core or Edge. product-name: type: string description: password used to access SDNC server. description: >- Persist SDNC address information used by ONAP SDNC. ###### Related Nodes - 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 esr-thirdparty-sdnc-list1: title: esr-thirdparty-sdnc-list1 type: object properties: esr-thirdparty-sdnc: type: array items: $ref: '#/components/schemas/esr-thirdparty-sdnc1' description: '' esr-vnfm1: title: esr-vnfm1 required: - vnfm-id type: object properties: vnfm-id: type: string description: Unique ID of VNFM. vim-id: type: string description: indecate the VIM to deploy VNF. certificate-url: type: string description: certificate url of VNFM. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. esr-system-info-list: type: array items: $ref: '#/components/schemas/esr-system-info1' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Persist VNFM address information used by VF-C. ###### Related Nodes - FROM esr-system-info (CHILD of esr-vnfm, esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1) - FROM generic-vnf( generic-vnf DependsOn esr-vnfm, MANY2ONE) -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also esr-vnfm2: title: esr-vnfm2 required: - vnfm-id type: object properties: vnfm-id: type: string description: Unique ID of VNFM. vim-id: type: string description: indecate the VIM to deploy VNF. certificate-url: type: string description: certificate url of VNFM. description: >- Persist VNFM address information used by VF-C. ###### Related Nodes - FROM esr-system-info (CHILD of esr-vnfm, esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1) - FROM generic-vnf( generic-vnf DependsOn esr-vnfm, MANY2ONE) -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also esr-vnfm-list1: title: esr-vnfm-list1 type: object properties: esr-vnfm: type: array items: $ref: '#/components/schemas/esr-vnfm1' description: '' evc1: title: evc1 required: - evc-id type: object properties: evc-id: type: string description: Unique/key field for the evc object forwarding-path-topology: type: string description: Point-to-Point, Multi-Point cir-value: type: string description: Commited Information Rate cir-units: type: string description: CIR units connection-diversity-group-id: type: string description: Diversity Group ID service-hours: type: string description: formerly Performance Group esp-evc-circuit-id: type: string description: EVC Circuit ID of ESP EVC esp-evc-cir-value: type: string description: Committed Information Rate (For ESP) esp-evc-cir-units: type: string description: CIR units (For ESP) esp-itu-code: type: string description: Identifies ESP collector-pop-clli: type: string description: Collector POP CLLI (from the hostname of the access pnf) inter-connect-type-ingress: type: string description: Interconnect type on ingress side of EVC. tagmode-access-ingress: type: string description: tagode for collector side of EVC tagmode-access-egress: type: string description: tagMode for network side of EVC product-entry-id: type: string description: Product ID relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. description: >- evc object is an optional child object of the Configuration object. ###### Related Nodes - TO configuration (PARENT of evc, evc BelongsTo configuration, ONE2ONE)(4) -(4) IF this TO node is deleted, this EVC is DELETED also evc2: title: evc2 required: - evc-id type: object properties: evc-id: type: string description: Unique/key field for the evc object forwarding-path-topology: type: string description: Point-to-Point, Multi-Point cir-value: type: string description: Commited Information Rate cir-units: type: string description: CIR units connection-diversity-group-id: type: string description: Diversity Group ID service-hours: type: string description: formerly Performance Group esp-evc-circuit-id: type: string description: EVC Circuit ID of ESP EVC esp-evc-cir-value: type: string description: Committed Information Rate (For ESP) esp-evc-cir-units: type: string description: CIR units (For ESP) esp-itu-code: type: string description: Identifies ESP collector-pop-clli: type: string description: Collector POP CLLI (from the hostname of the access pnf) inter-connect-type-ingress: type: string description: Interconnect type on ingress side of EVC. tagmode-access-ingress: type: string description: tagode for collector side of EVC tagmode-access-egress: type: string description: tagMode for network side of EVC product-entry-id: type: string description: Product ID description: >- evc object is an optional child object of the Configuration object. ###### Related Nodes - TO configuration (PARENT of evc, evc BelongsTo configuration, ONE2ONE)(4) -(4) IF this TO node is deleted, this EVC is DELETED also evcs1: title: evcs1 type: object properties: evc: type: array items: $ref: '#/components/schemas/evc1' description: '' ext-aai-network1: title: ext-aai-network1 required: - aai-id type: object properties: aai-id: type: string description: Unique ID of the referenced AAI. schema-version: type: string description: Schema version of the referenced AAI. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. esr-system-info: allOf: - $ref: '#/components/schemas/esr-system-info1' - description: >- Persist common address information of external systems. ###### Related Nodes - TO cloud-region (PARENT of esr-system-info, esr-system-info BelongsTo cloud-region, MANY2ONE)(4) - TO esr-ems (PARENT of esr-system-info, esr-system-info BelongsTo esr-ems, MANY2ONE)(4) - TO esr-nfvo (PARENT of esr-system-info, esr-system-info BelongsTo esr-nfvo, ONE2ONE)(4) - TO esr-thirdparty-sdnc (PARENT of esr-system-info, esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4) - TO esr-vnfm (PARENT of esr-system-info, esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4) - FROM ext-aai-network (PARENT of esr-system-info, ext-aai-network Uses esr-system-info, ONE2MANY) For CCVPN Usecase(3) -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also -ESR-SYSTEM-INFO cannot be deleted if related to EXT-AAI-NETWORK relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Refer to an external AAI in another ONAP. ###### Related Nodes - 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 ext-aai-network2: title: ext-aai-network2 required: - aai-id type: object properties: aai-id: type: string description: Unique ID of the referenced AAI. schema-version: type: string description: Schema version of the referenced AAI. description: >- Refer to an external AAI in another ONAP. ###### Related Nodes - 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 ext-aai-networks1: title: ext-aai-networks1 type: object properties: ext-aai-network: type: array items: $ref: '#/components/schemas/ext-aai-network1' description: '' flavor1: title: flavor1 required: - flavor-id - flavor-name - flavor-selflink type: object properties: flavor-id: type: string description: Flavor id, expected to be unique across cloud-region. flavor-name: type: string description: Cloud Region Flavor name flavor-vcpus: type: integer description: Number of CPUs format: int32 flavor-ram: type: integer description: Amount of memory format: int32 flavor-disk: type: integer description: Disk space format: int32 flavor-ephemeral: type: integer description: Amount of ephemeral disk space format: int32 flavor-swap: type: string description: amount of swap space allocation flavor-is-public: type: boolean description: whether flavor is available to all users or private to the tenant it was created in. flavor-selflink: type: string description: URL to endpoint where AAI can get more details flavor-disabled: type: boolean description: Boolean as to whether this flavor is no longer enabled hpa-capabilities: type: array items: $ref: '#/components/schemas/hpa-capability1' description: List of flavor specific HPA Capabilities resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Openstack flavor. ###### Related Nodes - 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 flavor2: title: flavor2 required: - flavor-id - flavor-name - flavor-selflink type: object properties: flavor-id: type: string description: Flavor id, expected to be unique across cloud-region. flavor-name: type: string description: Cloud Region Flavor name flavor-vcpus: type: integer description: Number of CPUs format: int32 flavor-ram: type: integer description: Amount of memory format: int32 flavor-disk: type: integer description: Disk space format: int32 flavor-ephemeral: type: integer description: Amount of ephemeral disk space format: int32 flavor-swap: type: string description: amount of swap space allocation flavor-is-public: type: boolean description: whether flavor is available to all users or private to the tenant it was created in. flavor-selflink: type: string description: URL to endpoint where AAI can get more details flavor-disabled: type: boolean description: Boolean as to whether this flavor is no longer enabled hpa-capabilities: type: array items: $ref: '#/components/schemas/hpa-capability2' description: List of flavor specific HPA Capabilities description: >- Openstack flavor. ###### Related Nodes - 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 flavors1: title: flavors1 type: object properties: flavor: type: array items: $ref: '#/components/schemas/flavor1' description: '' description: Collection of openstack flavors. forwarder1: title: forwarder1 required: - sequence type: object properties: sequence: type: integer description: Unique ID of this segmentation format: int32 forwarder-role: type: string description: ingress, intermediate, egress relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. description: >- Entity describing a sequenced segment of forwarding path ###### Related Nodes - 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 forwarder2: title: forwarder2 required: - sequence type: object properties: sequence: type: integer description: Unique ID of this segmentation format: int32 forwarder-role: type: string description: ingress, intermediate, egress description: >- Entity describing a sequenced segment of forwarding path ###### Related Nodes - 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 forwarder-evc1: title: forwarder-evc1 required: - forwarder-evc-id type: object properties: forwarder-evc-id: type: string description: Key for forwarder-evc object circuit-id: type: string description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC ivlan: type: string description: Internal VLAN. svlan: type: string description: SVLAN value for ingress of egress forwarder. cvlan: type: string description: CVLAN value for ingress of egress forwarder. vlan-mappings: type: array items: $ref: '#/components/schemas/vlan-mapping1' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. description: >- forwarder object is an optional child object of the Configuration object. ###### Related Nodes - 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-evc2: title: forwarder-evc2 required: - forwarder-evc-id type: object properties: forwarder-evc-id: type: string description: Key for forwarder-evc object circuit-id: type: string description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC ivlan: type: string description: Internal VLAN. svlan: type: string description: SVLAN value for ingress of egress forwarder. cvlan: type: string description: CVLAN value for ingress of egress forwarder. vlan-mappings: type: array items: $ref: '#/components/schemas/vlan-mapping2' description: '' description: >- forwarder object is an optional child object of the Configuration object. ###### Related Nodes - 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-evcs1: title: forwarder-evcs1 type: object properties: forwarder-evc: type: array items: $ref: '#/components/schemas/forwarder-evc1' description: '' forwarders1: title: forwarders1 type: object properties: forwarder: type: array items: $ref: '#/components/schemas/forwarder1' description: '' forwarding-path1: title: forwarding-path1 required: - forwarding-path-id - forwarding-path-name type: object properties: forwarding-path-id: type: string description: Unique ID of this FP forwarding-path-name: type: string description: Name of the FP relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. selflink: type: string description: the self link for this FP forwarders: type: array items: $ref: '#/components/schemas/forwarder1' description: '' description: >- Entity that describes the sequenced forwarding path between interfaces of services or resources ###### Related Nodes - 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-path2: title: forwarding-path2 required: - forwarding-path-id - forwarding-path-name type: object properties: forwarding-path-id: type: string description: Unique ID of this FP forwarding-path-name: type: string description: Name of the FP description: >- Entity that describes the sequenced forwarding path between interfaces of services or resources ###### Related Nodes - 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-paths1: title: forwarding-paths1 type: object properties: forwarding-path: type: array items: $ref: '#/components/schemas/forwarding-path1' description: '' generic-vnf1: title: generic-vnf1 required: - vnf-id - vnf-type - in-maint - is-closed-loop-disabled type: object properties: vnf-id: type: string description: Unique id of VNF. This is unique across the graph. vnf-instance-id: type: string description: vnf instance id. vnf-name: type: string description: Name of VNF. vnf-name2: type: string description: Alternate name of VNF. vnf-type: type: string description: 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: type: string description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED regional-resource-zone: type: string description: Regional way of organizing pservers, source of truth should define values prov-status: type: string description: Trigger for operational monitoring of this resource by Service Assurance systems. operational-status: type: string description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path. license-key: type: string description: OBSOLETE - do not use equipment-role: type: string description: Client should send valid enumerated value orchestration-status: type: string description: Orchestration status of this VNF, used by MSO. vnf-package-name: type: string vnf-discriptor-name: type: string description: vnf discriptor name job-id: type: string description: job id corresponding to vnf heat-stack-id: type: string description: Heat stack id corresponding to this instance, managed by MSO mso-catalog-key: type: string description: Corresponds to the SDN-C catalog id used to configure this VCE management-option: type: string description: identifier of managed customer ipv4-oam-address: type: string description: 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: type: string description: v4 Loopback0 address nm-lan-v6-address: type: string description: v6 Loopback address management-v6-address: type: string description: v6 management address vcpu: type: integer description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE format: int64 vcpu-units: type: string description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE vmemory: type: integer description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE format: int64 vmemory-units: type: string description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE vdisk: type: integer description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE format: int64 vdisk-units: type: string description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE nshd: type: integer description: number of associated SHD in vnf. format: int64 nvm: type: integer description: number of vms in vnf. format: int64 nnet: type: integer description: number of network in vnf. format: int64 in-maint: type: boolean description: 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: type: boolean description: used to indicate whether closed loop function is enabled on this node resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. summary-status: type: string description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD. encrypted-access-flag: type: boolean description: indicates whether generic-vnf access uses SSH entitlement-assignment-group-uuid: type: string description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE - See child relationships. entitlement-resource-uuid: type: string description: UUID of the specific entitlement resource. OBSOLETE - See child relationships. license-assignment-group-uuid: type: string description: UUID of the license assignment group. OBSOLETE - See child relationships. license-key-uuid: type: string description: UUID of the actual license resource. OBSOLETE - See child relationships. model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. persona-model-version: type: string description: the ASDC model version for this resource or service model. model-customization-id: type: string description: captures the id of all the configuration used to customize the resource for the service. widget-model-id: type: string description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. widget-model-version: type: string description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. as-number: type: string description: as-number of the VNF regional-resource-subzone: type: string description: represents sub zone of the rr plane nf-type: type: string description: Generic description of the type of NF nf-function: type: string description: English description of Network function that the specific VNF deployment is providing nf-role: type: string description: role in the network that this model will be providing nf-naming-code: type: string description: string assigned to this model used for naming purposes selflink: type: string description: Path to the controller object. ipv4-oam-gateway-address: type: string description: Gateway address ipv4-oam-gateway-address-prefix-length: type: integer description: Prefix length for oam-address format: int32 vlan-id-outer: type: integer description: Temporary location for S-TAG to get to VCE format: int64 nm-profile-name: type: string description: Network Management profile of this VNF relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' l-interfaces: type: array items: $ref: '#/components/schemas/l-interface1' description: '' lag-interfaces: type: array items: $ref: '#/components/schemas/lag-interface1' description: '' vf-modules: type: array items: $ref: '#/components/schemas/vf-module1' description: '' licenses: type: array items: $ref: '#/components/schemas/license1' description: '' entitlements: type: array items: $ref: '#/components/schemas/entitlement1' description: '' description: >- General purpose VNF ###### Related Nodes - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY) - TO cloud-region( generic-vnf LocatedIn cloud-region, MANY2ONE) - TO complex( generic-vnf LocatedIn complex, MANY2MANY) - TO configuration( generic-vnf Uses configuration, ONE2MANY)(2) - TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY) - TO esr-vnfm( generic-vnf DependsOn esr-vnfm, MANY2ONE) - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY) - TO instance-group( generic-vnf Uses instance-group, ONE2MANY) - TO 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 tenant( generic-vnf BelongsTo tenant, MANY2ONE) - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY) - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE) - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY) - TO vserver( generic-vnf HostedOn vserver, ONE2MANY) - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY) - FROM contact( contact supports generic-vnf, MANY2MANY) - FROM device( device Uses generic-vnf, ONE2MANY) For CCVPN Usecase - FROM entitlement (CHILD of generic-vnf, entitlement BelongsTo generic-vnf, MANY2ONE)(1) - FROM forwarder( forwarder AppliesTo generic-vnf, MANY2MANY) Points to the generic-vnf(s) involved in this forwarding step. - FROM 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 metadatum( metadatum AppliesTo generic-vnf, MANY2MANY) AAI-2154 For BBS Usecase - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY) - FROM platform( platform Uses generic-vnf, MANY2MANY) - FROM 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 generic-vnf2: title: generic-vnf2 required: - vnf-id - vnf-type - in-maint - is-closed-loop-disabled type: object properties: vnf-id: type: string description: Unique id of VNF. This is unique across the graph. vnf-instance-id: type: string description: vnf instance id. vnf-name: type: string description: Name of VNF. vnf-name2: type: string description: Alternate name of VNF. vnf-type: type: string description: 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: type: string description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED regional-resource-zone: type: string description: Regional way of organizing pservers, source of truth should define values prov-status: type: string description: Trigger for operational monitoring of this resource by Service Assurance systems. operational-status: type: string description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path. license-key: type: string description: OBSOLETE - do not use equipment-role: type: string description: Client should send valid enumerated value orchestration-status: type: string description: Orchestration status of this VNF, used by MSO. vnf-package-name: type: string vnf-discriptor-name: type: string description: vnf discriptor name job-id: type: string description: job id corresponding to vnf heat-stack-id: type: string description: Heat stack id corresponding to this instance, managed by MSO mso-catalog-key: type: string description: Corresponds to the SDN-C catalog id used to configure this VCE management-option: type: string description: identifier of managed customer ipv4-oam-address: type: string description: 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: type: string description: v4 Loopback0 address nm-lan-v6-address: type: string description: v6 Loopback address management-v6-address: type: string description: v6 management address vcpu: type: integer description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE format: int64 vcpu-units: type: string description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE vmemory: type: integer description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE format: int64 vmemory-units: type: string description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE vdisk: type: integer description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE format: int64 vdisk-units: type: string description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE nshd: type: integer description: number of associated SHD in vnf. format: int64 nvm: type: integer description: number of vms in vnf. format: int64 nnet: type: integer description: number of network in vnf. format: int64 in-maint: type: boolean description: 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: type: boolean description: used to indicate whether closed loop function is enabled on this node description: >- General purpose VNF ###### Related Nodes - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY) - TO cloud-region( generic-vnf LocatedIn cloud-region, MANY2ONE) - TO complex( generic-vnf LocatedIn complex, MANY2MANY) - TO configuration( generic-vnf Uses configuration, ONE2MANY)(2) - TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY) - TO esr-vnfm( generic-vnf DependsOn esr-vnfm, MANY2ONE) - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY) - TO instance-group( generic-vnf Uses instance-group, ONE2MANY) - TO 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 tenant( generic-vnf BelongsTo tenant, MANY2ONE) - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY) - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE) - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY) - TO vserver( generic-vnf HostedOn vserver, ONE2MANY) - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY) - FROM contact( contact supports generic-vnf, MANY2MANY) - FROM device( device Uses generic-vnf, ONE2MANY) For CCVPN Usecase - FROM entitlement (CHILD of generic-vnf, entitlement BelongsTo generic-vnf, MANY2ONE)(1) - FROM forwarder( forwarder AppliesTo generic-vnf, MANY2MANY) Points to the generic-vnf(s) involved in this forwarding step. - FROM 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 metadatum( metadatum AppliesTo generic-vnf, MANY2MANY) AAI-2154 For BBS Usecase - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY) - FROM platform( platform Uses generic-vnf, MANY2MANY) - FROM 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 generic-vnfs1: title: generic-vnfs1 type: object properties: generic-vnf: type: array items: $ref: '#/components/schemas/generic-vnf1' description: '' description: Collection of VNFs group-assignment1: title: group-assignment1 required: - group-id - group-type - group-name type: object properties: group-id: type: string description: Group id, expected to be unique across cloud-region. group-type: type: string description: Group type - the type of group this instance refers to group-name: type: string description: Group name - name assigned to the group group-description: type: string description: Group description - description of the group resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Openstack group-assignment used to store exclusivity groups (EG). ###### Related Nodes - 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-assignment2: title: group-assignment2 required: - group-id - group-type - group-name type: object properties: group-id: type: string description: Group id, expected to be unique across cloud-region. group-type: type: string description: Group type - the type of group this instance refers to group-name: type: string description: Group name - name assigned to the group group-description: type: string description: Group description - description of the group description: >- Openstack group-assignment used to store exclusivity groups (EG). ###### Related Nodes - 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-assignments1: title: group-assignments1 type: object properties: group-assignment: type: array items: $ref: '#/components/schemas/group-assignment1' description: '' description: Collection of openstack group assignments host-route1: title: host-route1 required: - host-route-id - route-prefix - next-hop type: object properties: host-route-id: type: string description: host-route id route-prefix: type: string description: subnet prefix next-hop: type: string description: Could be ip-address, hostname, or service-instance next-hop-type: type: string description: Should be ip-address, hostname, or service-instance to match next-hop resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- ###### Related Nodes - 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-route2: title: host-route2 required: - host-route-id - route-prefix - next-hop type: object properties: host-route-id: type: string description: host-route id route-prefix: type: string description: subnet prefix next-hop: type: string description: Could be ip-address, hostname, or service-instance next-hop-type: type: string description: Should be ip-address, hostname, or service-instance to match next-hop description: >- ###### Related Nodes - 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-routes1: title: host-routes1 type: object properties: host-route: type: array items: $ref: '#/components/schemas/host-route1' description: '' hpa-capabilities1: title: hpa-capabilities1 type: object properties: hpa-capability: type: array items: $ref: '#/components/schemas/hpa-capability1' description: '' description: Collection of HPA Capabilities hpa-capability1: title: hpa-capability1 required: - hpa-capability-id - hpa-feature type: object properties: hpa-capability-id: type: string description: UUID to uniquely identify a HPA capability hpa-feature: type: string description: Name of the HPACapability hpa-version: type: string description: HPA schema version architecture: type: string description: Hardware architecture resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' hpa-feature-attributes: type: array items: $ref: '#/components/schemas/hpa-feature-attributes1' description: '' description: >- Represents a HPA capability ###### Related Nodes - 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-capability2: title: hpa-capability2 required: - hpa-capability-id - hpa-feature type: object properties: hpa-capability-id: type: string description: UUID to uniquely identify a HPA capability hpa-feature: type: string description: Name of the HPACapability hpa-version: type: string description: HPA schema version architecture: type: string description: Hardware architecture description: >- Represents a HPA capability ###### Related Nodes - 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-capacity1: title: hpa-capacity1 required: - hpa-capacity-key type: object properties: hpa-capacity-key: type: string description: Composite key formed with hpaFeature and append list of hpaFeatureAttributes needed for capacity check hpa-capacity-value: type: string description: JSON string specifying the capacity (total,free), unit and metadata of the specific HPA attribute resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- HPA Capacity information for compute node ###### Related Nodes - 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-capacity2: title: hpa-capacity2 required: - hpa-capacity-key type: object properties: hpa-capacity-key: type: string description: Composite key formed with hpaFeature and append list of hpaFeatureAttributes needed for capacity check hpa-capacity-value: type: string description: JSON string specifying the capacity (total,free), unit and metadata of the specific HPA attribute description: >- HPA Capacity information for compute node ###### Related Nodes - 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-feature-attributes1: title: hpa-feature-attributes1 required: - hpa-attribute-key type: object properties: hpa-attribute-key: type: string description: name of the specific HPA attribute hpa-attribute-value: type: string description: JSON string specifying the value, unit and type of the specific HPA attribute resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- HPA Capability Feature attributes ###### Related Nodes - 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-feature-attributes2: title: hpa-feature-attributes2 required: - hpa-attribute-key type: object properties: hpa-attribute-key: type: string description: name of the specific HPA attribute hpa-attribute-value: type: string description: JSON string specifying the value, unit and type of the specific HPA attribute description: >- HPA Capability Feature attributes ###### Related Nodes - 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 image1: title: image1 required: - image-id - image-name - image-os-distro - image-os-version - image-selflink type: object properties: image-id: type: string description: Image id, expected to be unique across cloud region image-name: type: string description: Image name image-architecture: type: string description: Operating system architecture. image-os-distro: type: string description: The common name of the operating system distribution in lowercase image-os-version: type: string description: The operating system version as specified by the distributor. application: type: string description: The application that the image instantiates. application-vendor: type: string description: The vendor of the application. application-version: type: string description: The version of the application. image-selflink: type: string description: URL to endpoint where AAI can get more details resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' metadata: type: array items: $ref: '#/components/schemas/metadatum' description: '' description: >- Openstack image. ###### Related Nodes - 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 image2: title: image2 required: - image-id - image-name - image-os-distro - image-os-version - image-selflink type: object properties: image-id: type: string description: Image id, expected to be unique across cloud region image-name: type: string description: Image name image-architecture: type: string description: Operating system architecture. image-os-distro: type: string description: The common name of the operating system distribution in lowercase image-os-version: type: string description: The operating system version as specified by the distributor. application: type: string description: The application that the image instantiates. application-vendor: type: string description: The vendor of the application. application-version: type: string description: The version of the application. image-selflink: type: string description: URL to endpoint where AAI can get more details description: >- Openstack image. ###### Related Nodes - 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 images1: title: images1 type: object properties: image: type: array items: $ref: '#/components/schemas/image1' description: '' description: Collectio of Openstack images. instance-group1: title: instance-group1 required: - id - instance-group-type type: object properties: id: type: string description: Instance Group ID, UUID assigned to this instance. instance-group-role: type: string description: role of the instance group. model-invariant-id: type: string description: ASDC model id for this resource or service model. model-version-id: type: string description: ASDC model version uid for this resource model. description: type: string description: Descriptive text to help identify the usage of this instance-group instance-group-type: type: string description: Only valid value today is lower case ha for high availability resource-version: type: string description: Concurrency value instance-group-name: type: string description: Instance-Group Name. instance-group-function: type: string description: Instance-Group Function relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- General mechanism for grouping instances ###### Related Nodes - 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 Uses instance-group, ONE2MANY) MSO creates this edge on VNF Group Service creation - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY) - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY) - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY) - FROM vnfc( vnfc MemberOf instance-group, MANY2MANY) -(4) IF this TO node is deleted, this INSTANCE-GROUP is DELETED also instance-group2: title: instance-group2 required: - id - instance-group-type type: object properties: id: type: string description: Instance Group ID, UUID assigned to this instance. instance-group-role: type: string description: role of the instance group. model-invariant-id: type: string description: ASDC model id for this resource or service model. model-version-id: type: string description: ASDC model version uid for this resource model. description: type: string description: Descriptive text to help identify the usage of this instance-group instance-group-type: type: string description: Only valid value today is lower case ha for high availability description: >- General mechanism for grouping instances ###### Related Nodes - 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 Uses instance-group, ONE2MANY) MSO creates this edge on VNF Group Service creation - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY) - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY) - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY) - FROM vnfc( vnfc MemberOf instance-group, MANY2MANY) -(4) IF this TO node is deleted, this INSTANCE-GROUP is DELETED also instance-groups1: title: instance-groups1 type: object properties: instance-group: type: array items: $ref: '#/components/schemas/instance-group1' description: '' description: Collection of openstack route table references ipsec-configuration1: title: ipsec-configuration1 required: - ipsec-configuration-id type: object properties: ipsec-configuration-id: type: string description: UUID of this configuration requested-vig-address-type: type: string description: Indicate the type of VIG server like AVPN, INTERNET, BOTH requested-encryption-strength: type: string description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc requested-dmz-type: type: string description: Shared DMZ or a DMZ specific to a customer shared-dmz-network-address: type: string description: Network address of shared DMZ requested-customer-name: type: string description: If the DMZ is a custom DMZ, this field will indicate the customer information ike-version: type: string description: can be 1 or 2 ikev1-authentication: type: string description: Contains values like md5, sha1, sha256, sha384 ikev1-encryption: type: string description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc ikev1-dh-group: type: string description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14 ikev1-am-group-id: type: string description: Group name defined in VIG for clients using aggressive mode ikev1-am-password: type: string description: pre-shared key for the above group name ikev1-sa-lifetime: type: string description: Lifetime for IKEv1 SA ipsec-authentication: type: string description: md5, sha1, sha256, sha384 ipsec-encryption: type: string description: 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc ipsec-sa-lifetime: type: string description: Life time for IPSec SA ipsec-pfs: type: string description: enable PFS or not xauth-userid: type: string description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName xauth-user-password: type: string description: Encrypted using the Juniper $9$ algorithm dpd-interval: type: string description: The time between DPD probe dpd-frequency: type: string description: Maximum number of DPD before claiming the tunnel is down resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' vig-servers: type: array items: $ref: '#/components/schemas/vig-server1' description: '' description: >- 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 ###### Related Nodes - 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-configuration2: title: ipsec-configuration2 required: - ipsec-configuration-id type: object properties: ipsec-configuration-id: type: string description: UUID of this configuration requested-vig-address-type: type: string description: Indicate the type of VIG server like AVPN, INTERNET, BOTH requested-encryption-strength: type: string description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc requested-dmz-type: type: string description: Shared DMZ or a DMZ specific to a customer shared-dmz-network-address: type: string description: Network address of shared DMZ requested-customer-name: type: string description: If the DMZ is a custom DMZ, this field will indicate the customer information ike-version: type: string description: can be 1 or 2 ikev1-authentication: type: string description: Contains values like md5, sha1, sha256, sha384 ikev1-encryption: type: string description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc ikev1-dh-group: type: string description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14 ikev1-am-group-id: type: string description: Group name defined in VIG for clients using aggressive mode ikev1-am-password: type: string description: pre-shared key for the above group name ikev1-sa-lifetime: type: string description: Lifetime for IKEv1 SA ipsec-authentication: type: string description: md5, sha1, sha256, sha384 ipsec-encryption: type: string description: 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc ipsec-sa-lifetime: type: string description: Life time for IPSec SA ipsec-pfs: type: string description: enable PFS or not xauth-userid: type: string description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName xauth-user-password: type: string description: Encrypted using the Juniper $9$ algorithm dpd-interval: type: string description: The time between DPD probe dpd-frequency: type: string description: Maximum number of DPD before claiming the tunnel is down description: >- 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 ###### Related Nodes - 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-configurations1: title: ipsec-configurations1 type: object properties: ipsec-configuration: type: array items: $ref: '#/components/schemas/ipsec-configuration1' description: '' l3-interface-ipv4-address-list1: title: l3-interface-ipv4-address-list1 required: - l3-interface-ipv4-address type: object properties: l3-interface-ipv4-address: type: string description: IP address l3-interface-ipv4-prefix-length: type: integer description: Prefix length, 32 for single address format: int64 vlan-id-inner: type: integer description: Inner VLAN tag format: int64 vlan-id-outer: type: integer description: Outer VLAN tag format: int64 is-floating: type: boolean description: Indicator of fixed or floating address resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. neutron-network-id: type: string description: Neutron network id of the interface that address belongs to neutron-subnet-id: type: string description: Neutron id of subnet that address belongs to relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- IPv4 Address Range ###### Related Nodes - 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-ipv6-address-list1: title: l3-interface-ipv6-address-list1 required: - l3-interface-ipv6-address type: object properties: l3-interface-ipv6-address: type: string description: IP address l3-interface-ipv6-prefix-length: type: integer description: Prefix length, 128 for single address format: int64 vlan-id-inner: type: integer description: Inner VLAN tag format: int64 vlan-id-outer: type: integer description: Outer VLAN tag format: int64 is-floating: type: boolean description: Indicator of fixed or floating address resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. neutron-network-id: type: string description: Neutron network id of the interface that address belongs to neutron-subnet-id: type: string description: Neutron id of subnet that address belongs to relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- IPv6 Address Range ###### Related Nodes - 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-network1: title: l3-network1 required: - network-id - is-bound-to-vpn - is-provider-network - is-shared-network - is-external-network type: object properties: network-id: type: string description: Network ID, should be uuid. Unique across A&AI. network-name: type: string description: Name of the network, governed by some naming convention.. network-type: type: string description: Type of the network - who defines these values? network-role: type: string description: Role the network plans - who defines these values? network-technology: type: string description: Network technology - who defines these values? neutron-network-id: type: string description: Neutron network id of this Interface is-bound-to-vpn: type: boolean description: Set to true if bound to VPN service-id: type: string description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED network-role-instance: type: integer description: network role instance format: int64 resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. orchestration-status: type: string description: Orchestration status of this VNF, mastered by MSO heat-stack-id: type: string description: Heat stack id corresponding to this instance, managed by MSO mso-catalog-key: type: string description: Corresponds to the SDN-C catalog id used to configure this VCE contrail-network-fqdn: type: string description: Contrail FQDN for the network model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. persona-model-version: type: string description: the ASDC model version for this resource or service model. model-customization-id: type: string description: captures the id of all the configuration used to customize the resource for the service. widget-model-id: type: string description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. widget-model-version: type: string description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. physical-network-name: type: string description: Name associated with the physical network. is-provider-network: type: boolean description: boolean indicatating whether or not network is a provider network. is-shared-network: type: boolean description: boolean indicatating whether or not network is a shared network. is-external-network: type: boolean description: boolean indicatating whether or not network is an external network. selflink: type: string description: Path to the controller object. operational-status: type: string description: Indicator for whether the resource is considered operational. is-trunked: type: boolean description: Trunked network indication. subnets: type: array items: $ref: '#/components/schemas/subnet1' description: '' ctag-assignments: type: array items: $ref: '#/components/schemas/ctag-assignment1' description: '' segmentation-assignments: type: array items: $ref: '#/components/schemas/segmentation-assignment1' description: '' aggregate-routes: type: array items: $ref: '#/components/schemas/aggregate-route1' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding description: >- Generic network definition ###### Related Nodes - 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 aggregate-route (CHILD of l3-network, aggregate-route BelongsTo l3-network, MANY2ONE)(1) - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY) - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY) - FROM complex( complex Uses l3-network, MANY2MANY) - FROM configuration( configuration PartOf l3-network, MANY2MANY) - FROM ctag-assignment (CHILD of l3-network, ctag-assignment BelongsTo l3-network, MANY2ONE)(1) - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY) - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY) - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY) - FROM l3-network( l3-network Uses l3-network, MANY2MANY) - 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) - FROM vrf( vrf Uses l3-network, ONE2MANY) A vrf uses many l3-networks -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also l3-networks1: title: l3-networks1 type: object properties: l3-network: type: array items: $ref: '#/components/schemas/l3-network1' description: '' l3-interface-ipv4-address-list2: title: l3-interface-ipv4-address-list2 required: - l3-interface-ipv4-address type: object properties: l3-interface-ipv4-address: type: string description: IP address l3-interface-ipv4-prefix-length: type: integer description: Prefix length, 32 for single address format: int64 vlan-id-inner: type: integer description: Inner VLAN tag format: int64 vlan-id-outer: type: integer description: Outer VLAN tag format: int64 is-floating: type: boolean description: Indicator of fixed or floating address description: >- IPv4 Address Range ###### Related Nodes - 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-ipv6-address-list2: title: l3-interface-ipv6-address-list2 required: - l3-interface-ipv6-address type: object properties: l3-interface-ipv6-address: type: string description: IP address l3-interface-ipv6-prefix-length: type: integer description: Prefix length, 128 for single address format: int64 vlan-id-inner: type: integer description: Inner VLAN tag format: int64 vlan-id-outer: type: integer description: Outer VLAN tag format: int64 is-floating: type: boolean description: Indicator of fixed or floating address description: >- IPv6 Address Range ###### Related Nodes - 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-network2: title: l3-network2 required: - network-id - is-bound-to-vpn type: object properties: network-id: type: string description: Network ID, should be uuid. Unique across A&AI. network-name: type: string description: Name of the network, governed by some naming convention.. network-type: type: string description: Type of the network - who defines these values? network-role: type: string description: Role the network plans - who defines these values? network-technology: type: string description: Network technology - who defines these values? neutron-network-id: type: string description: Neutron network id of this Interface is-bound-to-vpn: type: boolean description: Set to true if bound to VPN service-id: type: string description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED network-role-instance: type: integer description: network role instance format: int64 description: >- Generic network definition ###### Related Nodes - 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 aggregate-route (CHILD of l3-network, aggregate-route BelongsTo l3-network, MANY2ONE)(1) - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY) - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY) - FROM complex( complex Uses l3-network, MANY2MANY) - FROM configuration( configuration PartOf l3-network, MANY2MANY) - FROM ctag-assignment (CHILD of l3-network, ctag-assignment BelongsTo l3-network, MANY2ONE)(1) - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY) - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY) - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY) - FROM l3-network( l3-network Uses l3-network, MANY2MANY) - 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) - FROM vrf( vrf Uses l3-network, ONE2MANY) A vrf uses many l3-networks -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also lag-interface1: title: lag-interface1 required: - interface-name - in-maint type: object properties: interface-name: type: string description: Name that identifies the link aggregate interface interface-description: type: string description: Human friendly text regarding this interface. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. speed-value: type: string description: Captures the numeric part of the speed speed-units: type: string description: Captures the units corresponding to the speed interface-id: type: string description: ID of interface interface-role: type: string description: Role assigned to this Interface, should use values as defined in ONAP Yang models. prov-status: type: string description: Trigger for operational monitoring of this resource by Service Assurance systems. in-maint: type: boolean description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' l-interfaces: type: array items: $ref: '#/components/schemas/l-interface1' description: '' description: >- Link aggregate interface ###### Related Nodes - 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 lag-interface2: title: lag-interface2 required: - interface-name type: object properties: interface-name: type: string description: Name that identifies the link aggregate interface interface-description: type: string description: Human friendly text regarding this interface. description: >- Link aggregate interface ###### Related Nodes - 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 lag-interfaces1: title: lag-interfaces1 type: object properties: lag-interface: type: array items: $ref: '#/components/schemas/lag-interface1' description: '' description: Collection of link aggregate interfaces. lag-link1: title: lag-link1 required: - link-name type: object properties: link-name: type: string description: Alphabetical concatenation of lag-interface names resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- LAG links can connect lag-interfaces ###### Related Nodes - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3) - FROM logical-link( logical-link Uses lag-link, MANY2MANY) -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also lag-link2: title: lag-link2 required: - link-name type: object properties: link-name: type: string description: Alphabetical concatenation of lag-interface names description: >- LAG links can connect lag-interfaces ###### Related Nodes - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3) - FROM logical-link( logical-link Uses lag-link, MANY2MANY) -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also lag-links1: title: lag-links1 type: object properties: lag-link: type: array items: $ref: '#/components/schemas/lag-link1' description: '' description: Collection of link aggregation connections lan-port-config1: title: lan-port-config1 required: - lan-port-config-id type: object properties: lan-port-config-id: type: string description: Uniquely identifies this lan-port-config by id lan-port-config-name: type: string description: Store the name of this lan-port-config. description: type: string description: Store the description of this lan-port-config. device-id: type: string description: Store the device-id of this lan-port-config. port-id: type: string description: Store the port-id of this lan-port-config. ipv4-address: type: string description: Store the ipv4-address of this lan-port-config. ipv6-address: type: string description: Store the ipv6-address of this lan-port-config. vlan-tag: type: string description: Store the vlan-tag of this lan-port-config. input-bandwidth: type: string description: Store the input-bandwidth of this lan-port-config. output-bandwidth: type: string description: Store the output-bandwidth of this lan-port-config. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. dhcp-services: type: array items: $ref: '#/components/schemas/dhcp-service1' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Instance of a lan-port-config ###### Related Nodes - 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-config2: title: lan-port-config2 required: - lan-port-config-id type: object properties: lan-port-config-id: type: string description: Uniquely identifies this lan-port-config by id lan-port-config-name: type: string description: Store the name of this lan-port-config. description: type: string description: Store the description of this lan-port-config. device-id: type: string description: Store the device-id of this lan-port-config. port-id: type: string description: Store the port-id of this lan-port-config. ipv4-address: type: string description: Store the ipv4-address of this lan-port-config. ipv6-address: type: string description: Store the ipv6-address of this lan-port-config. vlan-tag: type: string description: Store the vlan-tag of this lan-port-config. input-bandwidth: type: string description: Store the input-bandwidth of this lan-port-config. output-bandwidth: type: string description: Store the output-bandwidth of this lan-port-config. description: >- Instance of a lan-port-config ###### Related Nodes - 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-configs1: title: lan-port-configs1 type: object properties: lan-port-config: type: array items: $ref: '#/components/schemas/lan-port-config1' description: '' description: Collection of lan-port-configs license1: title: license1 required: - group-uuid - resource-uuid type: object properties: group-uuid: type: string description: Unique ID for the license group the resource belongs to, should be uuid. resource-uuid: type: string description: Unique ID of a license resource. resource-version: type: string description: Concurrency value relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Metadata for license group. ###### Related Nodes - 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 license2: title: license2 required: - group-uuid - resource-uuid type: object properties: group-uuid: type: string description: Unique ID for the license group the resource belongs to, should be uuid. resource-uuid: type: string description: Unique ID of a license resource. description: >- Metadata for license group. ###### Related Nodes - 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 licenses1: title: licenses1 type: object properties: license: type: array items: $ref: '#/components/schemas/license1' description: '' description: Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management line-of-business1: title: line-of-business1 required: - line-of-business-name type: object properties: line-of-business-name: type: string description: Name of the line-of-business (product) resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- describes a line-of-business ###### Related Nodes - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY) - TO l3-network( line-of-business Uses l3-network, MANY2MANY) line-of-business2: title: line-of-business2 required: - line-of-business-name type: object properties: line-of-business-name: type: string description: Name of the line-of-business (product) description: >- describes a line-of-business ###### Related Nodes - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY) - TO l3-network( line-of-business Uses l3-network, MANY2MANY) lines-of-business1: title: lines-of-business1 type: object properties: line-of-business: type: array items: $ref: '#/components/schemas/line-of-business1' description: '' description: Collection of lines-of-business l-interface1: title: l-interface1 required: - interface-name - is-port-mirrored - in-maint - is-ip-unnumbered type: object properties: interface-name: type: string description: Name given to the interface interface-role: type: string description: E.g., CUSTOMER, UPLINK, etc. v6-wan-link-ip: type: string description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B. selflink: type: string description: URL to endpoint where AAI can get more details interface-id: type: string description: ID of interface macaddr: type: string description: MAC address for the interface network-name: type: string description: Name of the network management-option: type: string description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER interface-description: type: string description: Human friendly text regarding this interface. is-port-mirrored: type: boolean description: boolean indicatating whether or not port is a mirrored. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. in-maint: type: boolean description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) prov-status: type: string description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV]. is-ip-unnumbered: type: boolean description: Flag indicating the interface uses the IP Unnumbered configuration. allowed-address-pairs: type: string description: Freeform field for storing an ip address, list of ip addresses or a subnet block. priority: type: integer description: Priority used for fail-over. Valid values 1-1024, with 1 being the highest priority. format: int32 vlans: type: array items: $ref: '#/components/schemas/vlan1' description: '' sriov-vfs: type: array items: $ref: '#/components/schemas/sriov-vf1' description: '' l-interfaces: type: array items: $ref: '#/components/schemas/l-interface1' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' l3-interface-ipv4-address-list: type: array items: $ref: '#/components/schemas/l3-interface-ipv4-address-list1' description: '' l3-interface-ipv6-address-list: type: array items: $ref: '#/components/schemas/l3-interface-ipv6-address-list1' description: '' admin-status: type: string description: Administrative status of the interface. Valid values are 'up', 'down', or 'testing'. description: >- Logical interfaces, e.g., a vnic. ###### Related Nodes - 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 vrf( vrf Uses l-interface, ONE2MANY) - FROM l3-interface-ipv4-address-list (CHILD of l-interface, l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1) - FROM l3-interface-ipv6-address-list (CHILD of l-interface, l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1) - FROM lag-interface( lag-interface Uses l-interface, 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 l-interface2: title: l-interface2 required: - interface-name - is-port-mirrored type: object properties: interface-name: type: string description: Name given to the interface interface-role: type: string description: E.g., CUSTOMER, UPLINK, etc. v6-wan-link-ip: type: string description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B. selflink: type: string description: URL to endpoint where AAI can get more details interface-id: type: string description: ID of interface macaddr: type: string description: MAC address for the interface network-name: type: string description: Name of the network management-option: type: string description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER interface-description: type: string description: Human friendly text regarding this interface. is-port-mirrored: type: boolean description: boolean indicatating whether or not port is a mirrored. description: >- Logical interfaces, e.g., a vnic. ###### Related Nodes - 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 vrf( vrf Uses l-interface, ONE2MANY) - FROM l3-interface-ipv4-address-list (CHILD of l-interface, l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1) - FROM l3-interface-ipv6-address-list (CHILD of l-interface, l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1) - FROM lag-interface( lag-interface Uses l-interface, 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 l-interfaces1: title: l-interfaces1 type: object properties: l-interface: type: array items: $ref: '#/components/schemas/l-interface1' description: '' description: Collection of logical interfaces. logical-link1: title: logical-link1 required: - link-name - in-maint - link-type type: object properties: link-name: type: string description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ in-maint: type: boolean description: 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. link-type: type: string description: Type of logical link, e.g., evc speed-value: type: string description: Captures the numeric part of the speed speed-units: type: string description: Captures the units corresponding to the speed ip-version: type: string description: v4, v6, or ds for dual stack routing-protocol: type: string description: For example, static or BGP resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. widget-model-id: type: string description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. widget-model-version: type: string description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. operational-status: type: string description: Indication of operational status of the logical link. prov-status: type: string description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. link-role: type: string description: Indication of the network use of the logical link. link-name2: type: string description: Alias or alternate name (CLCI or D1 name). link-id: type: string description: UUID of the logical-link, SDNC generates this. circuit-id: type: string description: Circuit id purpose: type: string description: Reason for this entity, role it is playing relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Logical links generally connect l-interfaces but are used to express logical connectivity between two points ###### Related Nodes - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY) - TO ext-aai-network( logical-link BelongsTo ext-aai-network, MANY2MANY) For CCVPN Usecase(2) - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY) - TO l-interface( logical-link Source l-interface, MANY2MANY)(4) - TO l-interface( logical-link Destination l-interface, MANY2MANY)(4) - TO lag-link( logical-link Uses lag-link, MANY2MANY) - TO logical-link( logical-link Uses logical-link, MANY2MANY) - TO pnf( logical-link BridgedTo pnf, MANY2MANY) - TO pserver( logical-link BridgedTo pserver, MANY2MANY) - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY) - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY) - FROM configuration( configuration Uses logical-link, ONE2MANY)(3) - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3) - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3) - FROM logical-link( logical-link Uses logical-link, MANY2MANY) - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE) - FROM service-instance( service-instance Uses logical-link, MANY2MANY)(3) - FROM vlan( vlan Uses logical-link, MANY2MANY)(3) -(2) IF this LOGICAL-LINK node is deleted, this TO node is DELETED also -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also -(4) IF this TO node is deleted, this LOGICAL-LINK is DELETED also logical-link2: title: logical-link2 required: - link-name - in-maint - link-type type: object properties: link-name: type: string description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ in-maint: type: boolean description: 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. link-type: type: string description: Type of logical link, e.g., evc speed-value: type: string description: Captures the numeric part of the speed speed-units: type: string description: Captures the units corresponding to the speed ip-version: type: string description: v4, v6, or ds for dual stack routing-protocol: type: string description: For example, static or BGP description: >- Logical links generally connect l-interfaces but are used to express logical connectivity between two points ###### Related Nodes - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY) - TO ext-aai-network( logical-link BelongsTo ext-aai-network, MANY2MANY) For CCVPN Usecase(2) - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY) - TO l-interface( logical-link Source l-interface, MANY2MANY)(4) - TO l-interface( logical-link Destination l-interface, MANY2MANY)(4) - TO lag-link( logical-link Uses lag-link, MANY2MANY) - TO logical-link( logical-link Uses logical-link, MANY2MANY) - TO pnf( logical-link BridgedTo pnf, MANY2MANY) - TO pserver( logical-link BridgedTo pserver, MANY2MANY) - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY) - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY) - FROM configuration( configuration Uses logical-link, ONE2MANY)(3) - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3) - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3) - FROM logical-link( logical-link Uses logical-link, MANY2MANY) - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE) - FROM service-instance( service-instance Uses logical-link, MANY2MANY)(3) - FROM vlan( vlan Uses logical-link, MANY2MANY)(3) -(2) IF this LOGICAL-LINK node is deleted, this TO node is DELETED also -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also -(4) IF this TO node is deleted, this LOGICAL-LINK is DELETED also logical-links1: title: logical-links1 type: object properties: logical-link: type: array items: $ref: '#/components/schemas/logical-link1' description: '' description: Collection of logical connections metadatum2: title: metadatum2 required: - metaname - metaval type: object properties: metaname: type: string metaval: type: string description: >- Key/value pairs ###### Related Nodes - TO configuration (PARENT of metadatum, metadatum BelongsTo configuration, MANY2ONE)(4) - TO connector (PARENT of metadatum, metadatum BelongsTo connector, MANY2ONE)(4) - TO cp( metadatum AppliesTo cp, MANY2MANY) AAI-2154 For BBS Usecase - TO generic-vnf( metadatum AppliesTo generic-vnf, MANY2MANY) AAI-2154 For BBS Usecase - TO image (PARENT of metadatum, metadatum BelongsTo image, MANY2ONE)(4) - TO model-ver (PARENT of metadatum, metadatum BelongsTo model-ver, MANY2ONE)(4) - TO pnf( metadatum AppliesTo pnf, MANY2MANY) AAI-2154 For BBS Usecase - TO service-instance (PARENT of metadatum, metadatum BelongsTo service-instance, MANY2ONE)(4) -(4) IF this TO node is deleted, this METADATUM is DELETED also model1: title: model1 required: - model-invariant-id - model-type type: object properties: model-invariant-id: type: string description: Unique identifier corresponding to the main definition of a model in ASDC model-type: type: string description: Type of the model, e.g., service, resource, widget, etc. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. model-vers: type: array items: $ref: '#/components/schemas/model-ver1' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version ###### Related Nodes - 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 model2: title: model2 required: - model-invariant-id - model-type type: object properties: model-invariant-id: type: string description: Unique identifier corresponding to the main definition of a model in ASDC model-type: type: string description: Type of the model, e.g., service, resource, widget, etc. description: >- Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version ###### Related Nodes - 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-constraint1: title: model-constraint1 required: - model-constraint-uuid - constrained-element-set-uuid-to-replace type: object properties: model-constraint-uuid: type: string constrained-element-set-uuid-to-replace: type: string constrained-element-sets: type: array items: $ref: '#/components/schemas/constrained-element-set1' description: '' resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. description: >- This is how we would capture constraints defining allowed sets of elements. ###### Related Nodes - 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-constraint2: title: model-constraint2 required: - model-constraint-uuid - constrained-element-set-uuid-to-replace type: object properties: model-constraint-uuid: type: string constrained-element-set-uuid-to-replace: type: string constrained-element-sets: type: array items: $ref: '#/components/schemas/constrained-element-set2' description: '' description: >- This is how we would capture constraints defining allowed sets of elements. ###### Related Nodes - 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-constraints1: title: model-constraints1 type: object properties: model-constraint: type: array items: $ref: '#/components/schemas/model-constraint1' description: '' model-element1: title: model-element1 required: - model-element-uuid - new-data-del-flag - cardinality type: object properties: model-element-uuid: type: string new-data-del-flag: type: string description: Indicates whether this element was created as part of instantiation from this model cardinality: type: string description: How many of this type of element are required/allowed linkage-points: type: string resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. model-elements: type: array items: $ref: '#/components/schemas/model-element1' description: Defines how other models combine to make up a higher-level model model-constraints: type: array items: $ref: '#/components/schemas/model-constraint1' description: Describes new constraints on this model element that are not part of that model's definition relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Defines how other models combine to make up a higher-level model. ###### Related Nodes - 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-element2: title: model-element2 required: - model-element-uuid - new-data-del-flag - cardinality type: object properties: model-element-uuid: type: string new-data-del-flag: type: string description: Indicates whether this element was created as part of instantiation from this model cardinality: type: string description: How many of this type of element are required/allowed linkage-points: type: string description: >- Defines how other models combine to make up a higher-level model. ###### Related Nodes - 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-elements1: title: model-elements1 type: object properties: model-element: type: array items: $ref: '#/components/schemas/model-element1' description: '' models1: title: models1 type: object properties: model: type: array items: $ref: '#/components/schemas/model1' description: '' description: Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models model-ver1: title: model-ver1 required: - model-version-id - model-name - model-version type: object properties: model-version-id: type: string description: Unique identifier corresponding to one version of a model in ASDC model-name: type: string description: Name of the model, which can change from version to version. model-version: type: string description: Version distribution-status: type: string description: Distribution Status model-description: type: string description: Description resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. model-elements: type: array items: $ref: '#/components/schemas/model-element1' description: '' metadata: type: array items: $ref: '#/components/schemas/metadatum' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models ###### Related Nodes - 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-ver2: title: model-ver2 required: - model-version-id - model-name - model-version type: object properties: model-version-id: type: string description: Unique identifier corresponding to one version of a model in ASDC model-name: type: string description: Name of the model, which can change from version to version. model-version: type: string description: Version distribution-status: type: string description: Distribution Status model-description: type: string description: Description description: >- Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models ###### Related Nodes - 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-vers1: title: model-vers1 type: object properties: model-ver: type: array items: $ref: '#/components/schemas/model-ver1' description: '' multicast-configuration1: title: multicast-configuration1 required: - multicast-configuration-id - multicast-protocol - rp-type type: object properties: multicast-configuration-id: type: string description: Unique id of multicast configuration. multicast-protocol: type: string description: protocol of multicast configuration rp-type: type: string description: rp type of multicast configuration resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- ###### Related Nodes - FROM vlan( vlan Uses multicast-configuration, MANY2MANY) multicast-configuration2: title: multicast-configuration2 required: - multicast-configuration-id - multicast-protocol - rp-type type: object properties: multicast-configuration-id: type: string description: Unique id of multicast configuration. multicast-protocol: type: string description: protocol of multicast configuration rp-type: type: string description: rp type of multicast configuration description: >- ###### Related Nodes - FROM vlan( vlan Uses multicast-configuration, MANY2MANY) multicast-configurations1: title: multicast-configurations1 type: object properties: multicast-configuration: type: array items: $ref: '#/components/schemas/multicast-configuration1' description: '' description: multicast configuration of generic-vnf ip-address named-queries1: title: named-queries1 type: object properties: named-query: type: array items: $ref: '#/components/schemas/named-query1' description: '' named-query1: title: named-query1 required: - named-query-uuid - named-query-name - named-query-version type: object properties: named-query-uuid: type: string named-query-name: type: string named-query-version: type: string required-input-param: type: string description: type: string resource-version: type: string named-query-elements: type: array items: $ref: '#/components/schemas/named-query-element1' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- TBD ###### Related Nodes - 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-query2: title: named-query2 required: - named-query-uuid - named-query-name - named-query-version type: object properties: named-query-uuid: type: string named-query-name: type: string named-query-version: type: string required-input-param: type: string description: type: string description: >- TBD ###### Related Nodes - 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-element1: title: named-query-element1 required: - named-query-element-uuid type: object properties: named-query-element-uuid: type: string property-collect-list: type: string resource-version: type: string property-limit-desc: type: string do-not-output: type: string named-query-elements: type: array items: $ref: '#/components/schemas/named-query-element1' description: '' related-lookups: type: array items: $ref: '#/components/schemas/related-lookup1' description: '' property-constraints: type: array items: $ref: '#/components/schemas/property-constraint' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- TBD ###### Related Nodes - 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-element2: title: named-query-element2 required: - named-query-element-uuid type: object properties: named-query-element-uuid: type: string property-collect-list: type: string description: >- TBD ###### Related Nodes - 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-elements1: title: named-query-elements1 type: object properties: named-query-element: type: array items: $ref: '#/components/schemas/named-query-element1' description: '' network-policies1: title: network-policies1 type: object properties: network-policy: type: array items: $ref: '#/components/schemas/network-policy1' description: '' network-policy1: title: network-policy1 required: - network-policy-id type: object properties: network-policy-id: type: string description: UUID representing unique key to this instance network-policy-fqdn: type: string description: Contrail FQDN for the policy heat-stack-id: type: string description: ID for the openStack Heat instance resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- ###### Related Nodes - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE) - FROM l3-network( l3-network Uses network-policy, MANY2MANY) network-policy2: title: network-policy2 required: - network-policy-id type: object properties: network-policy-id: type: string description: UUID representing unique key to this instance network-policy-fqdn: type: string description: Contrail FQDN for the policy heat-stack-id: type: string description: ID for the openStack Heat instance description: >- ###### Related Nodes - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE) - FROM l3-network( l3-network Uses network-policy, MANY2MANY) network-profile1: title: network-profile1 required: - nm-profile-name type: object properties: nm-profile-name: type: string description: Unique name of network profile. community-string: type: string description: Encrypted SNMP community string resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Network profile populated by SDN-GP for SNMP ###### Related Nodes - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY) network-profile2: title: network-profile2 required: - nm-profile-name type: object properties: nm-profile-name: type: string description: Unique name of network profile. community-string: type: string description: Encrypted SNMP community string description: >- Network profile populated by SDN-GP for SNMP ###### Related Nodes - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY) network-profiles1: title: network-profiles1 type: object properties: network-profile: type: array items: $ref: '#/components/schemas/network-profile1' description: '' description: Collection of network profiles network-resource1: title: network-resource1 required: - network-id type: object properties: network-id: type: string description: Uniquely identifies this network-resource by id provider-id: type: string description: Store the id of the provider of this network-resource. client-id: type: string description: Store the id of the client of this network-resource. te-topo-id: type: string description: Store the id of the te-topo of this network-resource. selflink: type: string description: Store the link to get more information for this object. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Instance of a network-resource ###### Related Nodes - 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-resource2: title: network-resource2 required: - network-id type: object properties: network-id: type: string description: Uniquely identifies this network-resource by id provider-id: type: string description: Store the id of the provider of this network-resource. client-id: type: string description: Store the id of the client of this network-resource. te-topo-id: type: string description: Store the id of the te-topo of this network-resource. selflink: type: string description: Store the link to get more information for this object. description: >- Instance of a network-resource ###### Related Nodes - 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-resources1: title: network-resources1 type: object properties: network-resource: type: array items: $ref: '#/components/schemas/network-resource1' description: '' description: Collection of network-resources network-technologies1: title: network-technologies1 type: object properties: network-technology: type: array items: $ref: '#/components/schemas/network-technology1' description: '' description: The network-technology object is used to capture the supported network technologies of a cloud-region. network-technology1: title: network-technology1 required: - network-technology-id - network-technology-name type: object properties: network-technology-id: type: string description: Unique identifier of the network-technology object (UUID) network-technology-name: type: string description: The network-technology that a cloud-region can support. Current valid values- CONTRAIL AIC_SR_IOV OVS STANDARD-SR-IOV resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- The network-technology object is used to capture the supported network technologies of a cloud-region. ###### Related Nodes - FROM cloud-region( cloud-region Uses network-technology, MANY2MANY) network-technology2: title: network-technology2 required: - network-technology-id - network-technology-name type: object properties: network-technology-id: type: string description: Unique identifier of the network-technology object (UUID) network-technology-name: type: string description: The network-technology that a cloud-region can support. Current valid values- CONTRAIL AIC_SR_IOV OVS STANDARD-SR-IOV description: >- The network-technology object is used to capture the supported network technologies of a cloud-region. ###### Related Nodes - FROM cloud-region( cloud-region Uses network-technology, MANY2MANY) newvce1: title: newvce1 required: - vnf-id2 - vnf-name - vnf-type type: object properties: vnf-id2: type: string description: Unique id of VNF, can't use same attribute name right now until we promote this new object vnf-name: type: string description: Name of VNF. vnf-name2: type: string description: Alternate name of VNF. vnf-type: type: string description: 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: type: string description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. operational-status: type: string description: Indicator for whether the resource is considered operational license-key: type: string description: OBSOLETE - do not use ipv4-oam-address: type: string description: 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: type: string description: Client should send valid enumerated value. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. ipv4-loopback0-address: type: string description: v4 Loopback0 address orchestration-status: type: string description: Orchestration status of this VNF, mastered by MSO. heat-stack-id: type: string description: Heat stack id corresponding to this instance, managed by MSO mso-catalog-key: type: string description: Corresponds to the SDN-C catalog id used to configure this VCE relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' l-interfaces: type: array items: $ref: '#/components/schemas/l-interface1' description: '' description: >- This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. ###### Related Nodes - 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 newvce2: title: newvce2 required: - vnf-id2 - vnf-name - vnf-type type: object properties: vnf-id2: type: string description: Unique id of VNF, can't use same attribute name right now until we promote this new object vnf-name: type: string description: Name of VNF. vnf-name2: type: string description: Alternate name of VNF. vnf-type: type: string description: 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: type: string description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. operational-status: type: string description: Indicator for whether the resource is considered operational license-key: type: string description: OBSOLETE - do not use ipv4-oam-address: type: string description: 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: type: string description: Client should send valid enumerated value. description: >- This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. ###### Related Nodes - 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 newvces1: title: newvces1 type: object properties: newvce: type: array items: $ref: '#/components/schemas/newvce1' description: '' description: This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. nos-server1: title: nos-server1 required: - nos-server-id - nos-server-name - vendor - nos-server-selflink - in-maint type: object properties: nos-server-id: type: string description: Unique identifier for this nos relative to its tenant nos-server-name: type: string description: Name of nos vendor: type: string description: uCPE vendor prov-status: type: string description: Trigger for operational monitoring of this resource by Service Assurance systems. nos-server-selflink: type: string description: URL to endpoint where AAI can get more details in-maint: type: boolean description: 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: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- nos-server is the execution environment that will have images, certain versions of VNOS, running on it. ###### Related Nodes - 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-server2: title: nos-server2 required: - nos-server-id - nos-server-name - vendor - nos-server-selflink - in-maint type: object properties: nos-server-id: type: string description: Unique identifier for this nos relative to its tenant nos-server-name: type: string description: Name of nos vendor: type: string description: uCPE vendor prov-status: type: string description: Trigger for operational monitoring of this resource by Service Assurance systems. nos-server-selflink: type: string description: URL to endpoint where AAI can get more details in-maint: type: boolean description: 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. description: >- nos-server is the execution environment that will have images, certain versions of VNOS, running on it. ###### Related Nodes - 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-servers1: title: nos-servers1 type: object properties: nos-server: type: array items: $ref: '#/components/schemas/nos-server1' description: '' description: nos-server is the execution environment that will have images, certain versions of VNOS, running on it. oam-network1: title: oam-network1 required: - network-uuid - network-name - cvlan-tag type: object properties: network-uuid: type: string description: UUID of the network. Unique across a cloud-region network-name: type: string description: Name of the network. cvlan-tag: type: integer description: cvlan-id format: int64 ipv4-oam-gateway-address: type: string description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network ipv4-oam-gateway-address-prefix-length: type: integer description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network format: int32 resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: "OAM network, to be deprecated shortly. Do not use for new purposes. \n###### Related Nodes\n- TO cloud-region (PARENT of oam-network, oam-network BelongsTo cloud-region, MANY2ONE)\n- TO complex( oam-network AppliesTo complex, MANY2MANY)\n- TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)" oam-network2: title: oam-network2 required: - network-uuid - network-name - cvlan-tag type: object properties: network-uuid: type: string description: UUID of the network. Unique across a cloud-region network-name: type: string description: Name of the network. cvlan-tag: type: integer description: cvlan-id format: int64 ipv4-oam-gateway-address: type: string description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network ipv4-oam-gateway-address-prefix-length: type: integer description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network format: int32 description: "OAM network, to be deprecated shortly. Do not use for new purposes. \n###### Related Nodes\n- TO cloud-region (PARENT of oam-network, oam-network BelongsTo cloud-region, MANY2ONE)\n- TO complex( oam-network AppliesTo complex, MANY2MANY)\n- TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)" oam-networks1: title: oam-networks1 type: object properties: oam-network: type: array items: $ref: '#/components/schemas/oam-network1' description: '' description: Collection of OAM networks, to be deprecated shortly. Do not use for new purposes. operational-environment1: title: operational-environment1 required: - operational-environment-id - operational-environment-name - operational-environment-type - operational-environment-status - tenant-context - workload-context type: object properties: operational-environment-id: type: string description: UUID of an operational environment operational-environment-name: type: string description: Operational Environment name operational-environment-type: type: string description: Operational Environment Type. operational-environment-status: type: string description: Status tenant-context: type: string description: Tenant Context. workload-context: type: string description: Workload Context. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- It is a logical partition of the cloud which allows to have multiple environments in the production AIC. ###### Related Nodes - TO operational-environment( operational-environment Uses operational-environment, MANY2MANY) - FROM operational-environment( operational-environment Uses operational-environment, MANY2MANY) operational-environment2: title: operational-environment2 required: - operational-environment-id - operational-environment-name - operational-environment-type - operational-environment-status - tenant-context - workload-context type: object properties: operational-environment-id: type: string description: UUID of an operational environment operational-environment-name: type: string description: Operational Environment name operational-environment-type: type: string description: Operational Environment Type. operational-environment-status: type: string description: Status tenant-context: type: string description: Tenant Context. workload-context: type: string description: Workload Context. description: >- It is a logical partition of the cloud which allows to have multiple environments in the production AIC. ###### Related Nodes - TO operational-environment( operational-environment Uses operational-environment, MANY2MANY) - FROM operational-environment( operational-environment Uses operational-environment, MANY2MANY) operational-environments1: title: operational-environments1 type: object properties: operational-environment: type: array items: $ref: '#/components/schemas/operational-environment1' description: '' description: a logical partition of the cloud which allows to have multiple environments in the production AIC. owning-entities1: title: owning-entities1 type: object properties: owning-entity: type: array items: $ref: '#/components/schemas/owning-entity1' description: '' description: Collection of owning-entities owning-entity1: title: owning-entity1 required: - owning-entity-id - owning-entity-name type: object properties: owning-entity-id: type: string description: UUID of an owning entity owning-entity-name: type: string description: Owning entity name resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- describes an owning-entity ###### Related Nodes - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE) owning-entity2: title: owning-entity2 required: - owning-entity-id - owning-entity-name type: object properties: owning-entity-id: type: string description: UUID of an owning entity owning-entity-name: type: string description: Owning entity name description: >- describes an owning-entity ###### Related Nodes - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE) physical-link1: title: physical-link1 required: - link-name type: object properties: link-name: type: string description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ speed-value: type: string description: Captures the numeric part of the speed speed-units: type: string description: Captures the units corresponding to the speed circuit-id: type: string description: Circuit it dual-mode: type: string description: Dual access mode (e.g., primary, secondary management-option: type: string description: To provide information on who manages this circuit. A&AI or 3rd party transport provider service-provider-name: type: string description: Name of the service Provider on this link. service-provider-bandwidth-up-value: type: integer description: Upstream Bandwidth value agreed with the service provider format: int32 service-provider-bandwidth-up-units: type: string description: Units for the upstream BW value service-provider-bandwidth-down-value: type: integer description: Downstream Bandwidth value agreed with the service provider format: int32 service-provider-bandwidth-down-units: type: string description: Units for downstream BW value resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Collection of physical connections, typically between p-interfaces ###### Related Nodes - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3) -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also physical-link2: title: physical-link2 required: - link-name type: object properties: link-name: type: string description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ speed-value: type: string description: Captures the numeric part of the speed speed-units: type: string description: Captures the units corresponding to the speed circuit-id: type: string description: Circuit it dual-mode: type: string description: Dual access mode (e.g., primary, secondary management-option: type: string description: To provide information on who manages this circuit. A&AI or 3rd party transport provider service-provider-name: type: string description: Name of the service Provider on this link. service-provider-bandwidth-up-value: type: integer description: Upstream Bandwidth value agreed with the service provider format: int32 service-provider-bandwidth-up-units: type: string description: Units for the upstream BW value service-provider-bandwidth-down-value: type: integer description: Downstream Bandwidth value agreed with the service provider format: int32 service-provider-bandwidth-down-units: type: string description: Units for downstream BW value description: >- Collection of physical connections, typically between p-interfaces ###### Related Nodes - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3) -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also physical-links1: title: physical-links1 type: object properties: physical-link: type: array items: $ref: '#/components/schemas/physical-link1' description: '' description: Collection of physical connections, typically between p-interfaces p-interface1: title: p-interface1 required: - interface-name - in-maint type: object properties: interface-name: type: string description: Name that identifies the physical interface selflink: type: string description: URL to endpoint where AAI can get more details. speed-value: type: string description: Captures the numeric part of the speed speed-units: type: string description: Captures the units corresponding to the speed port-description: type: string description: Nature of the services and connectivity on this port. equipment-identifier: type: string description: CLEI or other specification for p-interface hardware. interface-role: type: string description: Role specification for p-interface hardware. interface-type: type: string description: Indicates the physical properties of the interface. prov-status: type: string description: Trigger for operational monitoring of this resource by Service Assurance systems. mac-addresss: type: string description: MAC Address of the p-interface. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. in-maint: type: boolean description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) inv-status: type: string description: inventory status network-ref: type: string description: Store the network-ref of this p-interface. Derived from ietf-restconf-notification that identifies a termination-point. transparent: type: string description: Store the transparent value of this p-interface. operational-status: type: string description: oper Status of this p-interface. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' sriov-pfs: type: array items: $ref: '#/components/schemas/sriov-pf1' description: '' l-interfaces: type: array items: $ref: '#/components/schemas/l-interface1' description: '' description: >- Physical interface (e.g., nic) ###### Related Nodes - 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 allotted-resource( allotted-resource Uses p-interface, ONE2MANY) AAI-1925 For CCVPN Usecase - 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 p-interface2: title: p-interface2 required: - interface-name type: object properties: interface-name: type: string description: Name that identifies the physical interface selflink: type: string description: URL to endpoint where AAI can get more details. speed-value: type: string description: Captures the numeric part of the speed speed-units: type: string description: Captures the units corresponding to the speed port-description: type: string description: Nature of the services and connectivity on this port. equipment-identifier: type: string description: CLEI or other specification for p-interface hardware. interface-role: type: string description: Role specification for p-interface hardware. interface-type: type: string description: Indicates the physical properties of the interface. prov-status: type: string description: Trigger for operational monitoring of this resource by Service Assurance systems. mac-addresss: type: string description: MAC Address of the p-interface. description: >- Physical interface (e.g., nic) ###### Related Nodes - 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 allotted-resource( allotted-resource Uses p-interface, ONE2MANY) AAI-1925 For CCVPN Usecase - 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 p-interfaces1: title: p-interfaces1 type: object properties: p-interface: type: array items: $ref: '#/components/schemas/p-interface1' description: '' description: Collection of physical interfaces. platform1: title: platform1 required: - platform-name type: object properties: platform-name: type: string description: Name of the platform resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- describes a platform ###### Related Nodes - TO generic-vnf( platform Uses generic-vnf, MANY2MANY) - TO l3-network( platform Uses l3-network, MANY2MANY) platform2: title: platform2 required: - platform-name type: object properties: platform-name: type: string description: Name of the platform description: >- describes a platform ###### Related Nodes - TO generic-vnf( platform Uses generic-vnf, MANY2MANY) - TO l3-network( platform Uses l3-network, MANY2MANY) platforms1: title: platforms1 type: object properties: platform: type: array items: $ref: '#/components/schemas/platform1' description: '' description: Collection of platforms pnf1: title: pnf1 required: - pnf-name - in-maint type: object properties: pnf-name: type: string description: unique name of Physical Network Function. pnf-name2: type: string description: name of Physical Network Function. selflink: type: string description: URL to endpoint where AAI can get more details. pnf-name2-source: type: string description: source of name2 pnf-id: type: string description: id of pnf equip-type: type: string description: Equipment type. Source of truth should define valid values. equip-vendor: type: string description: Equipment vendor. Source of truth should define valid values. equip-model: type: string description: Equipment model. Source of truth should define valid values. management-option: type: string description: identifier of managed customer orchestration-status: type: string description: Orchestration status of this pnf ipaddress-v4-oam: type: string description: ipv4-oam-address with new naming convention for IP addresses sw-version: type: string description: sw-version is the version of SW for the hosted application on the PNF. in-maint: type: boolean description: 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: type: string description: ID of the physical frame (relay rack) where pnf is installed. serial-number: type: string description: Serial number of the device ipaddress-v4-loopback-0: type: string description: IPV4 Loopback 0 address ipaddress-v6-loopback-0: type: string description: IPV6 Loopback 0 address ipaddress-v4-aim: type: string description: IPV4 AIM address ipaddress-v6-aim: type: string description: IPV6 AIM address ipaddress-v6-oam: type: string description: IPV6 OAM address inv-status: type: string description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. prov-status: type: string description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV] nf-role: type: string description: Nf Role is the role performed by this instance in the network. admin-status: type: string description: admin Status of this PNF operational-status: type: string description: Store the operational-status for this object. model-customization-id: type: string description: Store the model-customization-id for this object. model-invariant-id: type: string description: The ASDC model id for this resource model. model-version-id: type: string description: The ASDC model version for this resource model. pnf-ipv4-address: type: string description: 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: type: string description: 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: type: array items: $ref: '#/components/schemas/software-version' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' p-interfaces: type: array items: $ref: '#/components/schemas/p-interface1' description: '' lag-interfaces: type: array items: $ref: '#/components/schemas/lag-interface1' description: '' vrfs: type: array items: $ref: '#/components/schemas/vrf1' description: '' description: >- 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. ###### Related Nodes - 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 metadatum( metadatum AppliesTo pnf, MANY2MANY) AAI-2154 For BBS Usecase - 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) - FROM vrf (CHILD of pnf, vrf BelongsTo pnf, MANY2ONE) A vrf belongs to a pnf.(1) -(1) IF this PNF node is deleted, this FROM node is DELETED also -(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 pnf2: title: pnf2 required: - pnf-name - in-maint type: object properties: pnf-name: type: string description: unique name of Physical Network Function. pnf-name2: type: string description: name of Physical Network Function. selflink: type: string description: URL to endpoint where AAI can get more details. pnf-name2-source: type: string description: source of name2 pnf-id: type: string description: id of pnf equip-type: type: string description: Equipment type. Source of truth should define valid values. equip-vendor: type: string description: Equipment vendor. Source of truth should define valid values. equip-model: type: string description: Equipment model. Source of truth should define valid values. management-option: type: string description: identifier of managed customer orchestration-status: type: string description: Orchestration status of this pnf ipaddress-v4-oam: type: string description: ipv4-oam-address with new naming convention for IP addresses sw-version: type: string description: sw-version is the version of SW for the hosted application on the PNF. in-maint: type: boolean description: 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: type: string description: ID of the physical frame (relay rack) where pnf is installed. serial-number: type: string description: Serial number of the device ipaddress-v4-loopback-0: type: string description: IPV4 Loopback 0 address ipaddress-v6-loopback-0: type: string description: IPV6 Loopback 0 address ipaddress-v4-aim: type: string description: IPV4 AIM address ipaddress-v6-aim: type: string description: IPV6 AIM address ipaddress-v6-oam: type: string description: IPV6 OAM address inv-status: type: string description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. description: >- 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. ###### Related Nodes - 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 metadatum( metadatum AppliesTo pnf, MANY2MANY) AAI-2154 For BBS Usecase - 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) - FROM vrf (CHILD of pnf, vrf BelongsTo pnf, MANY2ONE) A vrf belongs to a pnf.(1) -(1) IF this PNF node is deleted, this FROM node is DELETED also -(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 pnfs1: title: pnfs1 type: object properties: pnf: type: array items: $ref: '#/components/schemas/pnf1' description: '' description: Collection of Physical Network Functions. port-group1: title: port-group1 required: - interface-id - orchestration-status type: object properties: interface-id: type: string description: Unique ID of the interface neutron-network-id: type: string description: Neutron network id of this Interface neutron-network-name: type: string description: Neutron network name of this Interface interface-role: type: string description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. port-group-id: type: string description: Unique ID for port group in vmware port-group-name: type: string description: Likely to duplicate value of neutron network name switch-name: type: string description: DVS or standard switch name (should be non-null for port groups associated with DVS) orchestration-status: type: string description: Orchestration status of this VNF, mastered by MSO heat-stack-id: type: string description: Heat stack id corresponding to this instance, managed by MSO mso-catalog-key: type: string description: Corresponds to the SDN-C catalog id used to configure this VCE cvlan-tags: type: array items: $ref: '#/components/schemas/cvlan-tag-entry1' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Used to capture the network interfaces of this VCE ###### Related Nodes - 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 port-group2: title: port-group2 required: - interface-id type: object properties: interface-id: type: string description: Unique ID of the interface neutron-network-id: type: string description: Neutron network id of this Interface neutron-network-name: type: string description: Neutron network name of this Interface interface-role: type: string description: Role assigned to this Interface, should use values as defined in ECOMP Yang models. description: >- Used to capture the network interfaces of this VCE ###### Related Nodes - 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 port-groups1: title: port-groups1 type: object properties: port-group: type: array items: $ref: '#/components/schemas/port-group1' description: '' project1: title: project1 required: - project-name type: object properties: project-name: type: string description: Name of the project deploying a service resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- describes the project ###### Related Nodes - TO service-instance( project Uses service-instance, ONE2MANY) project2: title: project2 required: - project-name type: object properties: project-name: type: string description: Name of the project deploying a service description: >- describes the project ###### Related Nodes - TO service-instance( project Uses service-instance, ONE2MANY) projects1: title: projects1 type: object properties: project: type: array items: $ref: '#/components/schemas/project1' description: '' description: Collection of projects property-constraint2: title: property-constraint2 required: - property-constraint-uuid - constraint-type - property-name - property-value type: object properties: property-constraint-uuid: type: string constraint-type: type: string property-name: type: string property-value: type: string description: >- TBD ###### Related Nodes - 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 pserver1: title: pserver1 required: - hostname - in-maint type: object properties: hostname: type: string description: Value from executing hostname on the compute node. ptnii-equip-name: type: string description: PTNII name number-of-cpus: type: integer description: Number of cpus format: int32 disk-in-gigabytes: type: integer description: Disk size, in GBs format: int32 ram-in-megabytes: type: integer description: RAM size, in MBs format: int32 equip-type: type: string description: Equipment type. Source of truth should define valid values. equip-vendor: type: string description: Equipment vendor. Source of truth should define valid values. equip-model: type: string description: Equipment model. Source of truth should define valid values. fqdn: type: string description: Fully-qualified domain name pserver-selflink: type: string description: URL to endpoint where AAI can get more details ipv4-oam-address: type: string description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device. serial-number: type: string description: Serial number, may be queried ipaddress-v4-loopback-0: type: string description: IPV4 Loopback 0 address ipaddress-v6-loopback-0: type: string description: IPV6 Loopback 0 address ipaddress-v4-aim: type: string description: IPV4 AIM address ipaddress-v6-aim: type: string description: IPV6 AIM address ipaddress-v6-oam: type: string description: IPV6 OAM address inv-status: type: string description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. pserver-id: type: string description: ID of Pserver internet-topology: type: string description: internet topology of Pserver in-maint: type: boolean description: 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: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. pserver-name2: type: string description: alternative pserver name purpose: type: string description: purpose of pserver prov-status: type: string description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV] management-option: type: string description: Indicates who owns and or manages the device. host-profile: type: string description: The host profile that defines the configuration of the pserver. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' p-interfaces: type: array items: $ref: '#/components/schemas/p-interface1' description: '' lag-interfaces: type: array items: $ref: '#/components/schemas/lag-interface1' description: '' hpa-capacity: type: array items: $ref: '#/components/schemas/hpa-capacity1' description: '' description: >- Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver. ###### Related Nodes - 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 pserver2: title: pserver2 required: - hostname - in-maint type: object properties: hostname: type: string description: Value from executing hostname on the compute node. ptnii-equip-name: type: string description: PTNII name number-of-cpus: type: integer description: Number of cpus format: int32 disk-in-gigabytes: type: integer description: Disk size, in GBs format: int32 ram-in-megabytes: type: integer description: RAM size, in MBs format: int32 equip-type: type: string description: Equipment type. Source of truth should define valid values. equip-vendor: type: string description: Equipment vendor. Source of truth should define valid values. equip-model: type: string description: Equipment model. Source of truth should define valid values. fqdn: type: string description: Fully-qualified domain name pserver-selflink: type: string description: URL to endpoint where AAI can get more details ipv4-oam-address: type: string description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device. serial-number: type: string description: Serial number, may be queried ipaddress-v4-loopback-0: type: string description: IPV4 Loopback 0 address ipaddress-v6-loopback-0: type: string description: IPV6 Loopback 0 address ipaddress-v4-aim: type: string description: IPV4 AIM address ipaddress-v6-aim: type: string description: IPV6 AIM address ipaddress-v6-oam: type: string description: IPV6 OAM address inv-status: type: string description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI. pserver-id: type: string description: ID of Pserver internet-topology: type: string description: internet topology of Pserver in-maint: type: boolean description: 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. description: >- Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver. ###### Related Nodes - 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 pservers1: title: pservers1 type: object properties: pserver: type: array items: $ref: '#/components/schemas/pserver1' description: '' description: Collection of compute hosts. related-lookup1: title: related-lookup1 required: - related-lookup-uuid - source-node-type - source-node-property - target-node-type - target-node-property type: object properties: related-lookup-uuid: type: string source-node-type: type: string source-node-property: type: string target-node-type: type: string target-node-property: type: string property-collect-list: type: string resource-version: type: string relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- TBD ###### Related Nodes - TO named-query-element (PARENT of related-lookup, related-lookup BelongsTo named-query-element, MANY2ONE)(4) -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also related-lookup2: title: related-lookup2 required: - related-lookup-uuid - source-node-type - source-node-property - target-node-type - target-node-property type: object properties: related-lookup-uuid: type: string source-node-type: type: string source-node-property: type: string target-node-type: type: string target-node-property: type: string property-collect-list: type: string description: >- TBD ###### Related Nodes - TO named-query-element (PARENT of related-lookup, related-lookup BelongsTo named-query-element, MANY2ONE)(4) -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also related-lookups1: title: related-lookups1 type: object properties: related-lookup: type: array items: $ref: '#/components/schemas/related-lookup1' description: '' relationship1: title: relationship1 type: object properties: relationship: type: array items: $ref: '#/components/schemas/relationship-dict1' description: '' description: dictionary of relationship relationship-dict1: title: relationship-dict1 type: object properties: related-to: type: string description: A keyword provided by A&AI to indicate type of node. relationship-label: type: string description: The edge label for this relationship. related-link: type: string description: URL to the object in A&AI. relationship-data: type: array items: $ref: '#/components/schemas/relationship-data' description: '' related-to-property: type: array items: $ref: '#/components/schemas/related-to-property' description: '' route-table-reference1: title: route-table-reference1 required: - route-table-reference-id - route-table-reference-fqdn type: object properties: route-table-reference-id: type: string description: Route Table Reference id, UUID assigned to this instance. route-table-reference-fqdn: type: string description: FQDN entry in the route table. resource-version: type: string description: Concurrency value relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Openstack route table reference. ###### Related Nodes - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY) route-table-reference2: title: route-table-reference2 required: - route-table-reference-id - route-table-reference-fqdn type: object properties: route-table-reference-id: type: string description: Route Table Reference id, UUID assigned to this instance. route-table-reference-fqdn: type: string description: FQDN entry in the route table. description: >- Openstack route table reference. ###### Related Nodes - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY) route-table-references1: title: route-table-references1 type: object properties: route-table-reference: type: array items: $ref: '#/components/schemas/route-table-reference1' description: '' description: Collection of openstack route table references route-target1: title: route-target1 required: - global-route-target - route-target-role type: object properties: global-route-target: type: string description: Number used to identify an RT, globally unique in the network route-target-role: type: string description: Role assigned to this route target resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Route target information ###### Related Nodes - TO vpn-binding (PARENT of route-target, route-target BelongsTo vpn-binding, MANY2ONE)(4) - TO vrf (PARENT of route-target, route-target BelongsTo vrf, MANY2ONE)(4) -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also route-target2: title: route-target2 required: - global-route-target - route-target-role type: object properties: global-route-target: type: string description: Number used to identify an RT, globally unique in the network route-target-role: type: string description: Role assigned to this route target description: >- Route target information ###### Related Nodes - TO vpn-binding (PARENT of route-target, route-target BelongsTo vpn-binding, MANY2ONE)(4) - TO vrf (PARENT of route-target, route-target BelongsTo vrf, MANY2ONE)(4) -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also route-targets1: title: route-targets1 type: object properties: route-target: type: array items: $ref: '#/components/schemas/route-target1' description: '' description: Collection of route target information routing-instance1: title: routing-instance1 required: - routing-instance-id type: object properties: routing-instance-id: type: string description: Unique id of routing instance rpm-owner: type: string description: rpm owner resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. site-pairs: type: array items: $ref: '#/components/schemas/site-pair1' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- ###### Related Nodes - 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-instance2: title: routing-instance2 required: - routing-instance-id type: object properties: routing-instance-id: type: string description: Unique id of routing instance rpm-owner: type: string description: rpm owner description: >- ###### Related Nodes - 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-instances1: title: routing-instances1 type: object properties: routing-instance: type: array items: $ref: '#/components/schemas/routing-instance1' description: '' description: set of probes related to generic-vnf routing instance sdwan-vpn1: title: sdwan-vpn1 required: - sdwan-vpn-id type: object properties: sdwan-vpn-id: type: string description: Uniquely identifies this sdwan-vpn by id sdwan-vpn-name: type: string description: Store the name of this sdwan-vpn. vxlan-id: type: string description: Store the vxlan-id of this sdwan-vpn. topology: type: string description: Store the topology of this sdwan-vpn. tenant-id: type: string description: Store the tenant-id of this sdwan-vpn. vpn-id: type: string description: Store the vpn-id of this sdwan-vpn. selflink: type: string description: Store the link to get more information for this object. operational-status: type: string description: Store the operational-status for this object. model-customization-id: type: string description: Store the model-customization-id for this object. model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Instance of an sdwan-vpn ###### Related Nodes - 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-vpn2: title: sdwan-vpn2 required: - sdwan-vpn-id type: object properties: sdwan-vpn-id: type: string description: Uniquely identifies this sdwan-vpn by id sdwan-vpn-name: type: string description: Store the name of this sdwan-vpn. vxlan-id: type: string description: Store the vxlan-id of this sdwan-vpn. topology: type: string description: Store the topology of this sdwan-vpn. tenant-id: type: string description: Store the tenant-id of this sdwan-vpn. vpn-id: type: string description: Store the vpn-id of this sdwan-vpn. selflink: type: string description: Store the link to get more information for this object. operational-status: type: string description: Store the operational-status for this object. model-customization-id: type: string description: Store the model-customization-id for this object. model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. description: >- Instance of an sdwan-vpn ###### Related Nodes - 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-vpns1: title: sdwan-vpns1 type: object properties: sdwan-vpn: type: array items: $ref: '#/components/schemas/sdwan-vpn1' description: '' description: Collection of sdwan-vpns segmentation-assignment1: title: segmentation-assignment1 required: - segmentation-id type: object properties: segmentation-id: type: string description: Route Table Reference id, UUID assigned to this instance. resource-version: type: string description: Concurrency value relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Openstack segmentation assignment. ###### Related Nodes - 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-assignment2: title: segmentation-assignment2 required: - segmentation-id type: object properties: segmentation-id: type: string description: Route Table Reference id, UUID assigned to this instance. description: >- Openstack segmentation assignment. ###### Related Nodes - 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-assignments1: title: segmentation-assignments1 type: object properties: segmentation-assignment: type: array items: $ref: '#/components/schemas/segmentation-assignment1' description: '' description: Collection of openstack segmentation assignments service1: title: service1 required: - service-id - service-description type: object properties: service-id: type: string description: This gets defined by others to provide a unique ID for the service, we accept what is sent. service-description: type: string description: Description of the service service-selflink: type: string description: URL to endpoint where AAI can get more details resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. service-version: type: string description: service version relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services. service2: title: service2 required: - service-id - service-description type: object properties: service-id: type: string description: This gets defined by others to provide a unique ID for the service, we accept what is sent. service-description: type: string description: Description of the service service-selflink: type: string description: URL to endpoint where AAI can get more details description: Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services. service-capabilities1: title: service-capabilities1 type: object properties: service-capability: type: array items: $ref: '#/components/schemas/service-capability1' description: '' description: Collection of service capabilities. service-capability1: title: service-capability1 required: - service-type - vnf-type type: object properties: service-type: type: string description: This gets defined by others to provide a unique ID for the service, we accept what is sent. vnf-type: type: string description: String capturing type of vnf, that was intended to identify the SDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ONAP matures. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this. ###### Related Nodes - 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-capability2: title: service-capability2 required: - service-type - vnf-type type: object properties: service-type: type: string description: This gets defined by others to provide a unique ID for the service, we accept what is sent. vnf-type: type: string description: String capturing type of vnf, that was intended to identify the SDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ONAP matures. description: >- Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this. ###### Related Nodes - 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-instance1: title: service-instance1 required: - service-instance-id type: object properties: service-instance-id: type: string description: Uniquely identifies this instance of a service service-instance-name: type: string description: This field will store a name assigned to the service-instance. service-type: type: string description: String capturing type of service. service-role: type: string description: String capturing the service role. environment-context: type: string description: This field will store the environment context assigned to the service-instance. workload-context: type: string description: This field will store the workload context assigned to the service-instance. created-at: type: string description: create time of Network Service. updated-at: type: string description: last update of Network Service. description: type: string description: short description for service-instance. model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. persona-model-version: type: string description: the ASDC model version for this resource or service model. widget-model-id: type: string description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. widget-model-version: type: string description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. bandwidth-total: type: string description: Indicates the total bandwidth to be used for this service. vhn-portal-url: type: string description: URL customers will use to access the vHN Portal. service-instance-location-id: type: string description: An identifier that customers assign to the location where this service is being used. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. selflink: type: string description: Path to the controller object. orchestration-status: type: string description: Orchestration status of this service. input-parameters: type: string description: String capturing request parameters from SO to pass to Closed Loop. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' metadata: type: array items: $ref: '#/components/schemas/metadatum' description: '' allotted-resources: type: array items: $ref: '#/components/schemas/allotted-resource1' description: '' description: >- Instance of a service ###### Related Nodes - 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 Uses instance-group, ONE2MANY) MSO creates this edge on VNF Group Service creation - TO instance-group( service-instance MemberOf instance-group, MANY2MANY) - TO l3-network( service-instance ComposedOf l3-network, 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, ONE2MANY) 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-instance2: title: service-instance2 required: - service-instance-id type: object properties: service-instance-id: type: string description: Uniquely identifies this instance of a service service-instance-name: type: string description: This field will store a name assigned to the service-instance. service-type: type: string description: String capturing type of service. service-role: type: string description: String capturing the service role. environment-context: type: string description: This field will store the environment context assigned to the service-instance. workload-context: type: string description: This field will store the workload context assigned to the service-instance. created-at: type: string description: create time of Network Service. updated-at: type: string description: last update of Network Service. description: type: string description: short description for service-instance. model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. persona-model-version: type: string description: the ASDC model version for this resource or service model. widget-model-id: type: string description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. widget-model-version: type: string description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. bandwidth-total: type: string description: Indicates the total bandwidth to be used for this service. vhn-portal-url: type: string description: URL customers will use to access the vHN Portal. service-instance-location-id: type: string description: An identifier that customers assign to the location where this service is being used. description: >- Instance of a service ###### Related Nodes - 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 Uses instance-group, ONE2MANY) MSO creates this edge on VNF Group Service creation - TO instance-group( service-instance MemberOf instance-group, MANY2MANY) - TO l3-network( service-instance ComposedOf l3-network, 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, ONE2MANY) 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-instances1: title: service-instances1 type: object properties: service-instance: type: array items: $ref: '#/components/schemas/service-instance1' description: '' description: Collection of service instances services1: title: services1 type: object properties: service: type: array items: $ref: '#/components/schemas/service1' description: '' description: Collection of service model definitions. Likely to be deprecated in favor of models from ASDC. service-subscription1: title: service-subscription1 required: - service-type type: object properties: service-type: type: string description: Value defined by orchestration to identify this service across ONAP. temp-ub-sub-account-id: type: string description: This property will be deleted from A&AI in the near future. Only stop gap solution. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. service-instances: type: array items: $ref: '#/components/schemas/service-instance1' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Object that group service instances. ###### Related Nodes - 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-subscription2: title: service-subscription2 required: - service-type type: object properties: service-type: type: string description: Value defined by orchestration to identify this service across ONAP. temp-ub-sub-account-id: type: string description: This property will be deleted from A&AI in the near future. Only stop gap solution. description: >- Object that group service instances. ###### Related Nodes - 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-subscriptions1: title: service-subscriptions1 type: object properties: service-subscription: type: array items: $ref: '#/components/schemas/service-subscription1' description: '' description: Collection of objects that group service instances. site-pair1: title: site-pair1 required: - site-pair-id type: object properties: site-pair-id: type: string description: unique identifier of probe source-ip: type: string description: Prefix address destination-ip: type: string description: Prefix address ip-version: type: string description: ip version, v4, v6 destination-hostname: type: string description: Hostname of the destination equipment to which SLAs are measured against. destination-equip-type: type: string description: The type of destinatination equipment. Could be Router, UCPE, etc. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. classes-of-service: type: array items: $ref: '#/components/schemas/class-of-service1' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- ###### Related Nodes - 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-pair2: title: site-pair2 required: - site-pair-id type: object properties: site-pair-id: type: string description: unique identifier of probe source-ip: type: string description: Prefix address destination-ip: type: string description: Prefix address ip-version: type: string description: ip version, v4, v6 destination-hostname: type: string description: Hostname of the destination equipment to which SLAs are measured against. destination-equip-type: type: string description: The type of destinatination equipment. Could be Router, UCPE, etc. description: >- ###### Related Nodes - 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-pairs1: title: site-pairs1 type: object properties: site-pair: type: array items: $ref: '#/components/schemas/site-pair1' description: '' description: probe within a set site-pair-set1: title: site-pair-set1 required: - site-pair-set-id type: object properties: site-pair-set-id: type: string description: Unique id of site pair set. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. routing-instances: type: array items: $ref: '#/components/schemas/routing-instance1' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Set of instances for probes used to measure service level agreements ###### Related Nodes - 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-set2: title: site-pair-set2 required: - site-pair-set-id type: object properties: site-pair-set-id: type: string description: Unique id of site pair set. description: >- Set of instances for probes used to measure service level agreements ###### Related Nodes - 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-sets1: title: site-pair-sets1 type: object properties: site-pair-set: type: array items: $ref: '#/components/schemas/site-pair-set1' description: '' description: Collection of sets of instances for probes related to generic-vnf site-resource1: title: site-resource1 required: - site-resource-id type: object properties: site-resource-id: type: string description: Uniquely identifies this site-resource by id site-resource-name: type: string description: Store the name of this site-resource. description: type: string description: Store the description of this site-resource. type: type: string description: Store the type of this site-resource. role: type: string description: Store the role of this site-resource. generated-site-id: type: string description: Store the generated-site-id of this site-resource. selflink: type: string description: Store the link to get more information for this object. operational-status: type: string description: Store the operational-status for this object. model-customization-id: type: string description: Store the model-customization-id for this object. model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Instance of a site-resource ###### Related Nodes - 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-resource2: title: site-resource2 required: - site-resource-id type: object properties: site-resource-id: type: string description: Uniquely identifies this site-resource by id site-resource-name: type: string description: Store the name of this site-resource. description: type: string description: Store the description of this site-resource. type: type: string description: Store the type of this site-resource. role: type: string description: Store the role of this site-resource. generated-site-id: type: string description: Store the generated-site-id of this site-resource. selflink: type: string description: Store the link to get more information for this object. operational-status: type: string description: Store the operational-status for this object. model-customization-id: type: string description: Store the model-customization-id for this object. model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. description: >- Instance of a site-resource ###### Related Nodes - 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-resources1: title: site-resources1 type: object properties: site-resource: type: array items: $ref: '#/components/schemas/site-resource1' description: '' description: Collection of site-resources snapshot1: title: snapshot1 required: - snapshot-id type: object properties: snapshot-id: type: string description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. snapshot-name: type: string description: Snapshot name snapshot-architecture: type: string description: Operating system architecture snapshot-os-distro: type: string description: The common name of the operating system distribution in lowercase snapshot-os-version: type: string description: The operating system version as specified by the distributor. application: type: string description: The application that the image instantiates. application-vendor: type: string description: The vendor of the application. application-version: type: string description: The version of the application. snapshot-selflink: type: string description: URL to endpoint where AAI can get more details prev-snapshot-id: type: string description: This field contains the UUID of the previous snapshot (if any). resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Openstack snapshot ###### Related Nodes - TO cloud-region (PARENT of snapshot, snapshot BelongsTo cloud-region, MANY2ONE) - FROM vserver( vserver Uses snapshot, ONE2ONE) snapshot2: title: snapshot2 required: - snapshot-id type: object properties: snapshot-id: type: string description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots. snapshot-name: type: string description: Snapshot name snapshot-architecture: type: string description: Operating system architecture snapshot-os-distro: type: string description: The common name of the operating system distribution in lowercase snapshot-os-version: type: string description: The operating system version as specified by the distributor. application: type: string description: The application that the image instantiates. application-vendor: type: string description: The vendor of the application. application-version: type: string description: The version of the application. snapshot-selflink: type: string description: URL to endpoint where AAI can get more details prev-snapshot-id: type: string description: This field contains the UUID of the previous snapshot (if any). description: >- Openstack snapshot ###### Related Nodes - TO cloud-region (PARENT of snapshot, snapshot BelongsTo cloud-region, MANY2ONE) - FROM vserver( vserver Uses snapshot, ONE2ONE) snapshots1: title: snapshots1 type: object properties: snapshot: type: array items: $ref: '#/components/schemas/snapshot1' description: '' description: Collection of openstack snapshots sp-partner1: title: sp-partner1 required: - sp-partner-id type: object properties: sp-partner-id: type: string description: Uniquely identifies this sp-partner by id url: type: string description: Store the URL of this sp-partner. callsource: type: string description: Store the callsource of this sp-partner. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. operational-status: type: string description: Store the operational-status for this sp-partner. model-customization-id: type: string description: Store the model-customization-id for this sp-partner. model-invariant-id: type: string description: the ASDC model id for this sp-partner model. model-version-id: type: string description: the ASDC model version for this sp-partner model. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Instance of an sp-partner ###### Related Nodes - TO service-instance( sp-partner PartOf service-instance, ONE2MANY) For CCVPN Usecase sp-partner2: title: sp-partner2 required: - sp-partner-id type: object properties: sp-partner-id: type: string description: Uniquely identifies this sp-partner by id url: type: string description: Store the URL of this sp-partner. callsource: type: string description: Store the callsource of this sp-partner. description: >- Instance of an sp-partner ###### Related Nodes - TO service-instance( sp-partner PartOf service-instance, ONE2MANY) For CCVPN Usecase sp-partners1: title: sp-partners1 type: object properties: sp-partner: type: array items: $ref: '#/components/schemas/sp-partner1' description: '' description: Collection of sp-partners sriov-pf1: title: sriov-pf1 required: - pf-pci-id type: object properties: pf-pci-id: type: string description: Identifier for the sriov-pf resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- SR-IOV Physical Function ###### Related Nodes - 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 sriov-pf2: title: sriov-pf2 required: - pf-pci-id type: object properties: pf-pci-id: type: string description: Identifier for the sriov-pf description: >- SR-IOV Physical Function ###### Related Nodes - 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 sriov-pfs1: title: sriov-pfs1 type: object properties: sriov-pf: type: array items: $ref: '#/components/schemas/sriov-pf1' description: '' description: Collection of SR-IOV Physical Functions. sriov-vf1: title: sriov-vf1 required: - pci-id type: object properties: pci-id: type: string description: PCI ID used to identify the sriov-vf vf-vlan-filter: type: string description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. vf-mac-filter: type: string description: 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: type: boolean description: 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: type: boolean description: 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: type: boolean description: 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: type: string description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports. vf-broadcast-allow: type: boolean description: 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: type: boolean description: 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: type: boolean description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM vf-insert-stag: type: boolean description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM. vf-link-status: type: string description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. neutron-network-id: type: string description: Neutron network id of the interface relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- SR-IOV Virtual Function (not to be confused with virtual network function) ###### Related Nodes - 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 sriov-vf2: title: sriov-vf2 required: - pci-id type: object properties: pci-id: type: string description: PCI ID used to identify the sriov-vf vf-vlan-filter: type: string description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. vf-mac-filter: type: string description: 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: type: boolean description: 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: type: boolean description: 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: type: boolean description: 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: type: string description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports. vf-broadcast-allow: type: boolean description: 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: type: boolean description: 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: type: boolean description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM vf-insert-stag: type: boolean description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM. vf-link-status: type: string description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto. description: >- SR-IOV Virtual Function (not to be confused with virtual network function) ###### Related Nodes - 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 sriov-vfs1: title: sriov-vfs1 type: object properties: sriov-vf: type: array items: $ref: '#/components/schemas/sriov-vf1' description: '' description: Collection of SR-IOV Virtual Functions. subnet1: title: subnet1 required: - subnet-id - dhcp-enabled type: object properties: subnet-id: type: string description: Subnet ID, should be UUID. subnet-name: type: string description: Name associated with the subnet. neutron-subnet-id: type: string description: Neutron id of this subnet gateway-address: type: string description: gateway ip address network-start-address: type: string description: network start address cidr-mask: type: string description: cidr mask ip-version: type: string description: ip version orchestration-status: type: string description: Orchestration status of this VNF, mastered by MSO dhcp-enabled: type: boolean description: dhcp enabled dhcp-start: type: string description: the start address reserved for use by dhcp dhcp-end: type: string description: the last address reserved for use by dhcp subnet-role: type: string description: role of the subnet, referenced when assigning IPs ip-assignment-direction: type: string description: ip address assignment direction of the subnet resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. subnet-sequence: type: integer description: sequence of the subnet format: int32 host-routes: type: array items: $ref: '#/components/schemas/host-route1' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- ###### Related Nodes - 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 subnet2: title: subnet2 required: - subnet-id - dhcp-enabled type: object properties: subnet-id: type: string description: Subnet ID, should be UUID. subnet-name: type: string description: Name associated with the subnet. neutron-subnet-id: type: string description: Neutron id of this subnet gateway-address: type: string description: gateway ip address network-start-address: type: string description: network start address cidr-mask: type: string description: cidr mask ip-version: type: string description: ip version orchestration-status: type: string description: Orchestration status of this VNF, mastered by MSO dhcp-enabled: type: boolean description: dhcp enabled dhcp-start: type: string description: the start address reserved for use by dhcp dhcp-end: type: string description: the last address reserved for use by dhcp subnet-role: type: string description: role of the subnet, referenced when assigning IPs ip-assignment-direction: type: string description: ip address assignment direction of the subnet description: >- ###### Related Nodes - 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 subnets1: title: subnets1 type: object properties: subnet: type: array items: $ref: '#/components/schemas/subnet1' description: '' tenant1: title: tenant1 required: - tenant-id - tenant-name type: object properties: tenant-id: type: string description: Unique id relative to the cloud-region. tenant-name: type: string description: Readable name of tenant tenant-context: type: string description: This field will store the tenant context. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. vservers: type: array items: $ref: '#/components/schemas/vserver1' description: '' nos-servers: type: array items: $ref: '#/components/schemas/nos-server1' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Openstack tenant ###### Related Nodes - TO cloud-region (PARENT of tenant, tenant BelongsTo cloud-region, MANY2ONE) - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY) - TO l3-network( tenant Uses l3-network, MANY2MANY) - TO volume-group( tenant DependsOn volume-group, ONE2MANY) - FROM generic-vnf( generic-vnf BelongsTo tenant, MANY2ONE) - FROM 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 tenant2: title: tenant2 required: - tenant-id - tenant-name type: object properties: tenant-id: type: string description: Unique id relative to the cloud-region. tenant-name: type: string description: Readable name of tenant tenant-context: type: string description: This field will store the tenant context. description: >- Openstack tenant ###### Related Nodes - TO cloud-region (PARENT of tenant, tenant BelongsTo cloud-region, MANY2ONE) - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY) - TO l3-network( tenant Uses l3-network, MANY2MANY) - TO volume-group( tenant DependsOn volume-group, ONE2MANY) - FROM generic-vnf( generic-vnf BelongsTo tenant, MANY2ONE) - FROM 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 tenants1: title: tenants1 type: object properties: tenant: type: array items: $ref: '#/components/schemas/tenant1' description: '' description: Collection of openstack tenants. tunnel-xconnect1: title: tunnel-xconnect1 required: - id type: object properties: id: type: string description: Allotted Resource id UUID assigned to this instance. resource-version: type: string description: Concurrency value relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted ###### Related Nodes - 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 tunnel-xconnect2: title: tunnel-xconnect2 required: - id type: object properties: id: type: string description: Allotted Resource id UUID assigned to this instance. description: >- Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted ###### Related Nodes - 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 tunnel-xconnects1: title: tunnel-xconnects1 type: object properties: tunnel-xconnect: type: array items: $ref: '#/components/schemas/tunnel-xconnect1' description: '' description: This object is used to store the specific tunnel cross connect aspects of an allotted resource vce1: title: vce1 required: - vnf-id - vnf-name - vnf-type type: object properties: vnf-id: type: string description: Unique id of VNF. This is unique across the graph. vnf-name: type: string description: Name of VNF. vnf-name2: type: string description: Alternate name of VNF. vnf-type: type: string description: String capturing type of vnf, that was intended to identify the SDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ONAP matures. service-id: type: string description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. regional-resource-zone: type: string description: Regional way of organizing pservers, source of truth should define values prov-status: type: string description: Trigger for operational monitoring of this resource by Service Assurance systems. operational-status: type: string description: Indicator for whether the resource is considered operational license-key: type: string description: OBSOLETE - do not use equipment-role: type: string description: Network role being played by this VNF orchestration-status: type: string description: Orchestration status of this VNF, mastered by MSO heat-stack-id: type: string description: Heat stack id corresponding to this instance, managed by MSO mso-catalog-key: type: string description: Corresponds to the SDN-C catalog id used to configure this VCE vpe-id: type: string description: Unique ID of VPE connected to this VCE. v6-vce-wan-address: type: string description: Valid v6 IP address for the WAN Link on this router. Implied length of /64. ipv4-oam-address: type: string description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. ipv4-loopback0-address: type: string description: Loopback0 address entitlement-resource-uuid: type: string description: OBSOLETE - see child relationships port-groups: type: array items: $ref: '#/components/schemas/port-group1' description: '' licenses: type: array items: $ref: '#/components/schemas/license1' description: '' entitlements: type: array items: $ref: '#/components/schemas/entitlement1' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated. ###### Related Nodes - 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 vce2: title: vce2 required: - vnf-id - vnf-name - vnf-type type: object properties: vnf-id: type: string description: Unique id of VNF. This is unique across the graph. vnf-name: type: string description: Name of VNF. vnf-name2: type: string description: Alternate name of VNF. vnf-type: type: string description: String capturing type of vnf, that was intended to identify the SDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ONAP matures. service-id: type: string description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED. regional-resource-zone: type: string description: Regional way of organizing pservers, source of truth should define values prov-status: type: string description: Trigger for operational monitoring of this resource by Service Assurance systems. operational-status: type: string description: Indicator for whether the resource is considered operational license-key: type: string description: OBSOLETE - do not use equipment-role: type: string description: Network role being played by this VNF orchestration-status: type: string description: Orchestration status of this VNF, mastered by MSO heat-stack-id: type: string description: Heat stack id corresponding to this instance, managed by MSO mso-catalog-key: type: string description: Corresponds to the SDN-C catalog id used to configure this VCE vpe-id: type: string description: Unique ID of VPE connected to this VCE. v6-vce-wan-address: type: string description: Valid v6 IP address for the WAN Link on this router. Implied length of /64. ipv4-oam-address: type: string description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE. description: >- Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated. ###### Related Nodes - 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 vces1: title: vces1 type: object properties: vce: type: array items: $ref: '#/components/schemas/vce1' description: '' description: Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated. vf-module1: title: vf-module1 required: - vf-module-id - is-base-vf-module - automated-assignment type: object properties: vf-module-id: type: string description: Unique ID of vf-module. vf-module-name: type: string description: Name of vf-module heat-stack-id: type: string description: Heat stack id corresponding to this instance. orchestration-status: type: string description: orchestration status of this vf-module, mastered by MSO is-base-vf-module: type: boolean description: used to indicate whether or not this object is base vf module automated-assignment: type: boolean description: Indicates whether vf-module assignment was done via automation or manually resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. persona-model-version: type: string description: the ASDC model version for this resource or service model. model-customization-id: type: string description: captures the id of all the configuration used to customize the resource for the service. widget-model-id: type: string description: the ASDC data dictionary widget model. This maps directly to the A&AI widget. widget-model-version: type: string description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. contrail-service-instance-fqdn: type: string description: the Contrail unique ID for a service-instance module-index: type: integer description: 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 format: int32 selflink: type: string description: Path to the controller object. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- a deployment unit of VNFCs ###### Related Nodes - 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-module2: title: vf-module2 required: - vf-module-id - is-base-vf-module - automated-assignment type: object properties: vf-module-id: type: string description: Unique ID of vf-module. vf-module-name: type: string description: Name of vf-module heat-stack-id: type: string description: Heat stack id corresponding to this instance. orchestration-status: type: string description: orchestration status of this vf-module, mastered by MSO is-base-vf-module: type: boolean description: used to indicate whether or not this object is base vf module automated-assignment: type: boolean description: Indicates whether vf-module assignment was done via automation or manually description: >- a deployment unit of VNFCs ###### Related Nodes - 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-modules1: title: vf-modules1 type: object properties: vf-module: type: array items: $ref: '#/components/schemas/vf-module1' description: '' description: Collection of vf-modules, a deployment unit of VNFCs vig-server1: title: vig-server1 required: - vig-address-type type: object properties: vig-address-type: type: string description: indicates whether the VIG is for AVPN or INTERNET ipaddress-v4-vig: type: string description: v4 IP of the vig server ipaddress-v6-vig: type: string description: v6 IP of the vig server resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607 ###### Related Nodes - 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-server2: title: vig-server2 required: - vig-address-type type: object properties: vig-address-type: type: string description: indicates whether the VIG is for AVPN or INTERNET ipaddress-v4-vig: type: string description: v4 IP of the vig server ipaddress-v6-vig: type: string description: v6 IP of the vig server description: >- vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607 ###### Related Nodes - 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-servers1: title: vig-servers1 type: object properties: vig-server: type: array items: $ref: '#/components/schemas/vig-server1' description: '' vip-ipv4-address-list1: title: vip-ipv4-address-list1 required: - vip-ipv4-address type: object properties: vip-ipv4-address: type: string description: IP address vip-ipv4-prefix-length: type: integer description: Prefix length, 32 for single address format: int64 vlan-id-inner: type: integer description: Inner VLAN tag format: int64 vlan-id-outer: type: integer description: Outer VLAN tag format: int64 is-floating: type: boolean description: Indicator of fixed or floating address resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. neutron-network-id: type: string description: Neutron network id of the interface that address belongs to neutron-subnet-id: type: string description: Neutron id of subnet that address belongs to relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- IPv4 Address Range ###### Related Nodes - 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-ipv6-address-list1: title: vip-ipv6-address-list1 required: - vip-ipv6-address type: object properties: vip-ipv6-address: type: string description: IP address vip-ipv6-prefix-length: type: integer description: Prefix length, 128 for single address format: int64 vlan-id-inner: type: integer description: Inner VLAN tag format: int64 vlan-id-outer: type: integer description: Outer VLAN tag format: int64 is-floating: type: boolean description: Indicator of fixed or floating address resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. neutron-network-id: type: string description: Neutron network id of the interface that address belongs to neutron-subnet-id: type: string description: Neutron id of subnet that address belongs to relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- IPv6 Address Range ###### Related Nodes - 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-ipv4-address-list2: title: vip-ipv4-address-list2 required: - vip-ipv4-address type: object properties: vip-ipv4-address: type: string description: IP address vip-ipv4-prefix-length: type: integer description: Prefix length, 32 for single address format: int64 vlan-id-inner: type: integer description: Inner VLAN tag format: int64 vlan-id-outer: type: integer description: Outer VLAN tag format: int64 is-floating: type: boolean description: Indicator of fixed or floating address description: >- IPv4 Address Range ###### Related Nodes - 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-ipv6-address-list2: title: vip-ipv6-address-list2 required: - vip-ipv6-address type: object properties: vip-ipv6-address: type: string description: IP address vip-ipv6-prefix-length: type: integer description: Prefix length, 128 for single address format: int64 vlan-id-inner: type: integer description: Inner VLAN tag format: int64 vlan-id-outer: type: integer description: Outer VLAN tag format: int64 is-floating: type: boolean description: Indicator of fixed or floating address description: >- IPv6 Address Range ###### Related Nodes - 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) virtual-data-center1: title: virtual-data-center1 required: - vdc-id - vdc-name type: object properties: vdc-id: type: string description: Unique ID of the vdc vdc-name: type: string description: Name of the virtual data center resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Virtual organization of cloud infrastructure elements in a data center context ###### Related Nodes - 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) virtual-data-center2: title: virtual-data-center2 required: - vdc-id - vdc-name type: object properties: vdc-id: type: string description: Unique ID of the vdc vdc-name: type: string description: Name of the virtual data center description: >- Virtual organization of cloud infrastructure elements in a data center context ###### Related Nodes - 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) virtual-data-centers1: title: virtual-data-centers1 type: object properties: virtual-data-center: type: array items: $ref: '#/components/schemas/virtual-data-center1' description: '' description: Virtual organization of cloud infrastructure elements in a data center context vlan1: title: vlan1 required: - vlan-interface - in-maint - is-ip-unnumbered type: object properties: vlan-interface: type: string description: String that identifies the interface vlan-id-inner: type: integer description: Inner VLAN tag format: int64 vlan-id-outer: type: integer description: Outer VLAN tag format: int64 resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. speed-value: type: string description: Captures the numeric part of the speed speed-units: type: string description: Captures the units corresponding to the speed vlan-description: type: string description: Used to describe (the service associated with) the vlan backdoor-connection: type: string description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device. vpn-key: type: string description: This indicates the customers VPN ID associated with this vlan orchestration-status: type: string description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C. in-maint: type: boolean description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) prov-status: type: string description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV]. is-ip-unnumbered: type: boolean description: Flag indicating the interface uses the IP Unnumbered configuration. is-private: type: boolean description: Private VLAN indicator. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' l3-interface-ipv4-address-list: type: array items: $ref: '#/components/schemas/l3-interface-ipv4-address-list1' description: '' l3-interface-ipv6-address-list: type: array items: $ref: '#/components/schemas/l3-interface-ipv6-address-list1' description: '' description: >- Definition of vlan ###### Related Nodes - 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 vlan2: title: vlan2 required: - vlan-interface type: object properties: vlan-interface: type: string description: String that identifies the interface vlan-id-inner: type: integer description: Inner VLAN tag format: int64 vlan-id-outer: type: integer description: Outer VLAN tag format: int64 description: >- Definition of vlan ###### Related Nodes - 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-mapping1: title: vlan-mapping1 required: - vlan-mapping-id type: object properties: vlan-mapping-id: type: string description: Key for vlan-mapping object. uni-cvlan: type: string description: CVLAN value from the UNI/ingress side of the SAREA gateway access device. nni-svlan: type: string description: SVLAN value from the NNI/egress side of the SAREA gateway access device. nni-cvlan: type: string description: CVLAN value from the NNI/egress side of the SAREA gateway access device. ivlan: type: string description: The internal VLAN ('IVLAN') value. Specific to Arista devices. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' resource-version: type: string description: >- vlan-mapping object is an optional child object of the forwarder-evc object. A given forwarder-evc object may have multiple vlan-mapping objects. ###### Related Nodes - 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-mapping2: title: vlan-mapping2 required: - vlan-mapping-id type: object properties: vlan-mapping-id: type: string description: Key for vlan-mapping object. uni-cvlan: type: string description: CVLAN value from the UNI/ingress side of the SAREA gateway access device. nni-svlan: type: string description: SVLAN value from the NNI/egress side of the SAREA gateway access device. nni-cvlan: type: string description: CVLAN value from the NNI/egress side of the SAREA gateway access device. ivlan: type: string description: The internal VLAN ('IVLAN') value. Specific to Arista devices. description: >- vlan-mapping object is an optional child object of the forwarder-evc object. A given forwarder-evc object may have multiple vlan-mapping objects. ###### Related Nodes - 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-mappings1: title: vlan-mappings1 type: object properties: vlan-mapping: type: array items: $ref: '#/components/schemas/vlan-mapping1' description: '' description: Collection of vlan mappings. vlans1: title: vlans1 type: object properties: vlan: type: array items: $ref: '#/components/schemas/vlan1' description: '' vlan-tag1: title: vlan-tag1 required: - vlan-tag-id - vlan-tag-role - vlan-id-outer - is-private type: object properties: vlan-tag-id: type: string description: Unique ID of the vlan-tag vlan-tag-role: type: string description: purpose (l3-network to be connected to) vlan-id-inner: type: integer description: VLAN inner id format: int32 vlan-id-outer: type: integer description: VLAN outer id format: int32 is-private: type: boolean description: is VLAN private? resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- ###### Related Nodes - 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-tag2: title: vlan-tag2 required: - vlan-tag-id - vlan-tag-role - vlan-id-outer - is-private type: object properties: vlan-tag-id: type: string description: Unique ID of the vlan-tag vlan-tag-role: type: string description: purpose (l3-network to be connected to) vlan-id-inner: type: integer description: VLAN inner id format: int32 vlan-id-outer: type: integer description: VLAN outer id format: int32 is-private: type: boolean description: is VLAN private? description: >- ###### Related Nodes - 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-tags1: title: vlan-tags1 type: object properties: vlan-tag: type: array items: $ref: '#/components/schemas/vlan-tag1' description: '' vnfc1: title: vnfc1 required: - vnfc-name - nfc-naming-code - nfc-function - in-maint - is-closed-loop-disabled type: object properties: vnfc-name: type: string description: Unique ID of vnfc. nfc-naming-code: type: string description: Short code that is used in naming instances of the item being modeled nfc-function: type: string description: 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: type: string description: prov status of this vnfc orchestration-status: type: string description: Orchestration status of this VNF, mastered by APP-C ipaddress-v4-oam-vip: type: string description: Oam V4 vip address of this vnfc in-maint: type: boolean description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) is-closed-loop-disabled: type: boolean description: used to indicate whether closed loop function is enabled on this node group-notation: type: string description: Group notation of VNFC model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. model-customization-id: type: string description: captures the id of all the configuration used to customize the resource for the service. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' cps: type: array items: $ref: '#/components/schemas/cp1' description: '' l3-interface-ipv4-address-list: type: array items: $ref: '#/components/schemas/l3-interface-ipv4-address-list1' description: '' l3-interface-ipv6-address-list: type: array items: $ref: '#/components/schemas/l3-interface-ipv6-address-list1' description: '' description: >- ###### Related Nodes - 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 vnfc2: title: vnfc2 required: - vnfc-name - nfc-naming-code - nfc-function - in-maint - is-closed-loop-disabled type: object properties: vnfc-name: type: string description: Unique ID of vnfc. nfc-naming-code: type: string description: Short code that is used in naming instances of the item being modeled nfc-function: type: string description: 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: type: string description: prov status of this vnfc orchestration-status: type: string description: Orchestration status of this VNF, mastered by APP-C ipaddress-v4-oam-vip: type: string description: Oam V4 vip address of this vnfc in-maint: type: boolean description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true) is-closed-loop-disabled: type: boolean description: used to indicate whether closed loop function is enabled on this node group-notation: type: string description: Group notation of VNFC model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. model-customization-id: type: string description: captures the id of all the configuration used to customize the resource for the service. description: >- ###### Related Nodes - 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 vnfcs1: title: vnfcs1 type: object properties: vnfc: type: array items: $ref: '#/components/schemas/vnfc1' description: '' description: virtual network components associated with a vserver from application controller. vnf-image1: title: vnf-image1 required: - vnf-image-uuid - application - application-vendor type: object properties: vnf-image-uuid: type: string description: Unique ID of this asset application: type: string description: The application that the image instantiates. application-vendor: type: string description: The vendor of the application. application-version: type: string description: The version of the application. selflink: type: string description: URL to endpoint where AAI can get more details resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge. ###### Related Nodes - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE) -VNF-IMAGE cannot be deleted if related to GENERIC-VNF vnf-image2: title: vnf-image2 required: - vnf-image-uuid - application - application-vendor type: object properties: vnf-image-uuid: type: string description: Unique ID of this asset application: type: string description: The application that the image instantiates. application-vendor: type: string description: The vendor of the application. application-version: type: string description: The version of the application. selflink: type: string description: URL to endpoint where AAI can get more details description: >- Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge. ###### Related Nodes - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE) -VNF-IMAGE cannot be deleted if related to GENERIC-VNF vnf-images1: title: vnf-images1 type: object properties: vnf-image: type: array items: $ref: '#/components/schemas/vnf-image1' description: '' description: Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge. volume1: title: volume1 required: - volume-id - volume-selflink type: object properties: volume-id: type: string description: Unique ID of block storage volume relative to the vserver. volume-selflink: type: string description: URL to endpoint where AAI can get more details resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Ephemeral Block storage volume. ###### Related Nodes - FROM vserver (PARENT of volume, vserver AttachesTo volume, ONE2MANY)(3) -(3) IF this FROM node is deleted, this VOLUME is DELETED also volume2: title: volume2 required: - volume-id - volume-selflink type: object properties: volume-id: type: string description: Unique ID of block storage volume relative to the vserver. volume-selflink: type: string description: URL to endpoint where AAI can get more details description: >- Ephemeral Block storage volume. ###### Related Nodes - FROM vserver (PARENT of volume, vserver AttachesTo volume, ONE2MANY)(3) -(3) IF this FROM node is deleted, this VOLUME is DELETED also volume-group1: title: volume-group1 required: - volume-group-id - vnf-type type: object properties: volume-group-id: type: string description: Unique ID of volume-group. volume-group-name: type: string description: Name of the volume group. heat-stack-id: type: string description: Heat stack id corresponding to this volume-group vnf-type: type: string description: String capturing type of vnf, that was intended to identify the SDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ONAP matures. orchestration-status: type: string description: Orchestration status of this volume-group model-customization-id: type: string description: captures the id of all the configuration used to customize the resource for the service. vf-module-model-customization-id: type: string description: helps relate the volume group to the vf-module whose components will require the volume group resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Persistent block-level storage. ###### Related Nodes - 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-group2: title: volume-group2 required: - volume-group-id - vnf-type type: object properties: volume-group-id: type: string description: Unique ID of volume-group. volume-group-name: type: string description: Name of the volume group. heat-stack-id: type: string description: Heat stack id corresponding to this volume-group vnf-type: type: string description: String capturing type of vnf, that was intended to identify the SDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ONAP matures. orchestration-status: type: string description: Orchestration status of this volume-group model-customization-id: type: string description: captures the id of all the configuration used to customize the resource for the service. vf-module-model-customization-id: type: string description: helps relate the volume group to the vf-module whose components will require the volume group description: >- Persistent block-level storage. ###### Related Nodes - 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-groups1: title: volume-groups1 type: object properties: volume-group: type: array items: $ref: '#/components/schemas/volume-group1' description: '' description: Collection of persistent block-level storage. volumes1: title: volumes1 type: object properties: volume: type: array items: $ref: '#/components/schemas/volume1' description: '' description: Collection of ephemeral Block storage volumes. vpls-pe1: title: vpls-pe1 required: - equipment-name type: object properties: equipment-name: type: string prov-status: type: string description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. ipv4-oam-address: type: string description: 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: type: string description: Client should send valid enumerated value, e.g., VPLS-PE. vlan-id-outer: type: integer description: Temporary location for stag to get to VCE format: int64 resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' p-interfaces: type: array items: $ref: '#/components/schemas/p-interface1' description: '' lag-interfaces: type: array items: $ref: '#/components/schemas/lag-interface1' description: '' description: >- VPLS Provider Edge routers. ###### Related Nodes - 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 vpls-pe2: title: vpls-pe2 required: - equipment-name type: object properties: equipment-name: type: string prov-status: type: string description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems. ipv4-oam-address: type: string description: 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: type: string description: Client should send valid enumerated value, e.g., VPLS-PE. vlan-id-outer: type: integer description: Temporary location for stag to get to VCE format: int64 description: >- VPLS Provider Edge routers. ###### Related Nodes - 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 vpls-pes1: title: vpls-pes1 type: object properties: vpls-pe: type: array items: $ref: '#/components/schemas/vpls-pe1' description: '' description: Collection of VPLS Provider Edge routers vpn-binding1: title: vpn-binding1 required: - vpn-id - vpn-name type: object properties: vpn-id: type: string description: VPN ID, globally unique within A&AI vpn-name: type: string description: VPN Name vpn-platform: type: string description: the platform associated with the VPN example AVPN, Mobility vpn-type: type: string description: Type of the vpn, should be taken from enumerated/valid values vpn-region: type: string description: region of customer vpn customer-vpn-id: type: string description: id for this customer vpn route-distinguisher: type: string description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network. access-provider-id: type: string description: Store the id of the access provider of this vpn. access-client-id: type: string description: Store the id of the access client of this vpn. access-topology-id: type: string description: Store the id of the access topology of this vpn. src-access-node-id: type: string description: Store the id of the src-access-node of this vpn. src-access-ltp-id: type: string description: Store the id of the src-access-ltp of this vpn. dst-access-node-id: type: string description: Store the id of the dst-access-node of this vpn. dst-access-ltp-id: type: string description: Store the id of the dst-access-ltp of this vpn. operational-status: type: string description: Store the operational-status for this object. model-customization-id: type: string description: Store the model-customization-id for this object. model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. route-targets: type: array items: $ref: '#/components/schemas/route-target1' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: l3-networks relate to vpn-bindings description: >- VPN binding ###### Related Nodes - 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 - FROM vrf( vrf AppliesTo vpn-binding, MANY2ONE) A vrf uses a vpn-binding. -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also -(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-binding2: title: vpn-binding2 required: - vpn-id - vpn-name type: object properties: vpn-id: type: string description: VPN ID, globally unique within A&AI vpn-name: type: string description: VPN Name vpn-platform: type: string description: the platform associated with the VPN example AVPN, Mobility vpn-type: type: string description: Type of the vpn, should be taken from enumerated/valid values vpn-region: type: string description: region of customer vpn customer-vpn-id: type: string description: id for this customer vpn route-distinguisher: type: string description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network. access-provider-id: type: string description: Store the id of the access provider of this vpn. access-client-id: type: string description: Store the id of the access client of this vpn. access-topology-id: type: string description: Store the id of the access topology of this vpn. src-access-node-id: type: string description: Store the id of the src-access-node of this vpn. src-access-ltp-id: type: string description: Store the id of the src-access-ltp of this vpn. dst-access-node-id: type: string description: Store the id of the dst-access-node of this vpn. dst-access-ltp-id: type: string description: Store the id of the dst-access-ltp of this vpn. operational-status: type: string description: Store the operational-status for this object. model-customization-id: type: string description: Store the model-customization-id for this object. model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. description: >- VPN binding ###### Related Nodes - 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 - FROM vrf( vrf AppliesTo vpn-binding, MANY2ONE) A vrf uses a vpn-binding. -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also -(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-bindings1: title: vpn-bindings1 type: object properties: vpn-binding: type: array items: $ref: '#/components/schemas/vpn-binding1' description: '' vrf1: title: vrf1 required: - vrf-id - vrf-name type: object properties: vrf-id: type: string description: VRF UUID. vrf-name: type: string description: VRF Name vrf-description: type: string description: VRF Description route-distinguisher: type: string description: Route Distinguisher vrf-type: type: string description: The type of vrf (bridge-domain as an example) vrf-address-family: type: string description: IP address family (v6/v4/both) resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. route-targets: type: array items: $ref: '#/components/schemas/route-target1' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Definition of vrf ###### Related Nodes - TO l-interface( vrf Uses l-interface, ONE2MANY) - TO l3-network( vrf Uses l3-network, ONE2MANY) A vrf uses many l3-networks - TO pnf (PARENT of vrf, vrf BelongsTo pnf, MANY2ONE) A vrf belongs to a pnf.(4) - TO vpn-binding( vrf AppliesTo vpn-binding, MANY2ONE) A vrf uses a vpn-binding. - FROM configuration( configuration Uses vrf, ONE2MANY) A Configuration uses VRFs - FROM route-target (CHILD of vrf, route-target BelongsTo vrf, MANY2ONE)(1) -(1) IF this VRF node is deleted, this FROM node is DELETED also -(4) IF this TO node is deleted, this VRF is DELETED also vrf2: title: vrf2 required: - vrf-id - vrf-name type: object properties: vrf-id: type: string description: VRF UUID. vrf-name: type: string description: VRF Name vrf-description: type: string description: VRF Description route-distinguisher: type: string description: Route Distinguisher vrf-type: type: string description: The type of vrf (bridge-domain as an example) vrf-address-family: type: string description: IP address family (v6/v4/both) description: >- Definition of vrf ###### Related Nodes - TO l-interface( vrf Uses l-interface, ONE2MANY) - TO l3-network( vrf Uses l3-network, ONE2MANY) A vrf uses many l3-networks - TO pnf (PARENT of vrf, vrf BelongsTo pnf, MANY2ONE) A vrf belongs to a pnf.(4) - TO vpn-binding( vrf AppliesTo vpn-binding, MANY2ONE) A vrf uses a vpn-binding. - FROM configuration( configuration Uses vrf, ONE2MANY) A Configuration uses VRFs - FROM route-target (CHILD of vrf, route-target BelongsTo vrf, MANY2ONE)(1) -(1) IF this VRF node is deleted, this FROM node is DELETED also -(4) IF this TO node is deleted, this VRF is DELETED also vrfs1: title: vrfs1 type: object properties: vrf: type: array items: $ref: '#/components/schemas/vrf1' description: '' vserver1: title: vserver1 required: - vserver-id - vserver-name - vserver-selflink - in-maint - is-closed-loop-disabled type: object properties: vserver-id: type: string description: Unique identifier for this vserver relative to its tenant vserver-name: type: string description: Name of vserver vserver-name2: type: string description: Alternative name of vserver prov-status: type: string description: Trigger for operational monitoring of this resource by Service Assurance systems. vserver-selflink: type: string description: URL to endpoint where AAI can get more details in-maint: type: boolean description: 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: type: boolean description: Used to indicate whether closed loop function is enabled on this node resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. volumes: type: array items: $ref: '#/components/schemas/volume1' description: '' relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' l-interfaces: type: array items: $ref: '#/components/schemas/l-interface1' description: '' description: >- Virtual Servers, aka virtual machine or VM. ###### Related Nodes - 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 vserver2: title: vserver2 required: - vserver-id - vserver-name - vserver-selflink - in-maint - is-closed-loop-disabled type: object properties: vserver-id: type: string description: Unique identifier for this vserver relative to its tenant vserver-name: type: string description: Name of vserver vserver-name2: type: string description: Alternative name of vserver prov-status: type: string description: Trigger for operational monitoring of this resource by Service Assurance systems. vserver-selflink: type: string description: URL to endpoint where AAI can get more details in-maint: type: boolean description: 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: type: boolean description: Used to indicate whether closed loop function is enabled on this node description: >- Virtual Servers, aka virtual machine or VM. ###### Related Nodes - 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 vservers1: title: vservers1 type: object properties: vserver: type: array items: $ref: '#/components/schemas/vserver1' description: '' description: Collection of virtual Servers, aka virtual machines or VMs. wan-port-config1: title: wan-port-config1 required: - wan-port-config-id type: object properties: wan-port-config-id: type: string description: Uniquely identifies this wan-port-config by id wan-port-config-name: type: string description: Store the name of this wan-port-config. device-id: type: string description: Store the id of the device of this wan-port-config. vlan-id: type: string description: Store the id of the vlan of this wan-port-config. ip-address: type: string description: Store the ip-address of this wan-port-config. ipv4-address: type: string description: Store the ipv4-address of this wan-port-config. ipv6-address: type: string description: Store the ipv6-address of this wan-port-config. provider-ip-address: type: string description: Store the provider-ip-address of this wan-port-config. provider-ipv4-address: type: string description: Store the provider-ipv4-address of this wan-port-config. provider-ipv6-address: type: string description: Store the provider-ipv6-address of this wan-port-config. input-bandwidth: type: string description: Store the input-bandwidth of this wan-port-config. output-bandwidth: type: string description: Store the output-bandwidth of this wan-port-config. description: type: string description: Store the description of this wan-port-config. port-type: type: string description: Store the port-type of this wan-port-config. port-number: type: string description: Store the port-number of this wan-port-config. transport-network-name: type: string description: Store the transport-network-name of this wan-port-config. device-port-id: type: string description: Store the device-port-id of this wan-port-config. wan-port-id: type: string description: Store the wan-port-id of this wan-port-config. selflink: type: string description: Store the link to get more information for this object. operational-status: type: string description: Store the operational-status for this object. model-customization-id: type: string description: Store the model-customization-id for this object. model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. resource-version: type: string description: Used for optimistic concurrency. Must be empty on create, valid on update and delete. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- Instance of a wan-port-config ###### Related Nodes - 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, ONE2MANY) For CCVPN Usecase -(2) IF this WAN-PORT-CONFIG node is deleted, this TO node is DELETED also wan-port-config2: title: wan-port-config2 required: - wan-port-config-id type: object properties: wan-port-config-id: type: string description: Uniquely identifies this wan-port-config by id wan-port-config-name: type: string description: Store the name of this wan-port-config. device-id: type: string description: Store the id of the device of this wan-port-config. vlan-id: type: string description: Store the id of the vlan of this wan-port-config. ip-address: type: string description: Store the ip-address of this wan-port-config. ipv4-address: type: string description: Store the ipv4-address of this wan-port-config. ipv6-address: type: string description: Store the ipv6-address of this wan-port-config. provider-ip-address: type: string description: Store the provider-ip-address of this wan-port-config. provider-ipv4-address: type: string description: Store the provider-ipv4-address of this wan-port-config. provider-ipv6-address: type: string description: Store the provider-ipv6-address of this wan-port-config. input-bandwidth: type: string description: Store the input-bandwidth of this wan-port-config. output-bandwidth: type: string description: Store the output-bandwidth of this wan-port-config. description: type: string description: Store the description of this wan-port-config. port-type: type: string description: Store the port-type of this wan-port-config. port-number: type: string description: Store the port-number of this wan-port-config. transport-network-name: type: string description: Store the transport-network-name of this wan-port-config. device-port-id: type: string description: Store the device-port-id of this wan-port-config. wan-port-id: type: string description: Store the wan-port-id of this wan-port-config. selflink: type: string description: Store the link to get more information for this object. operational-status: type: string description: Store the operational-status for this object. model-customization-id: type: string description: Store the model-customization-id for this object. model-invariant-id: type: string description: the ASDC model id for this resource or service model. model-version-id: type: string description: the ASDC model version for this resource or service model. description: >- Instance of a wan-port-config ###### Related Nodes - 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, ONE2MANY) For CCVPN Usecase -(2) IF this WAN-PORT-CONFIG node is deleted, this TO node is DELETED also wan-port-configs1: title: wan-port-configs1 type: object properties: wan-port-config: type: array items: $ref: '#/components/schemas/wan-port-config1' description: '' description: Collection of wan-port-configs zone1: title: zone1 required: - zone-id - zone-name - design-type - zone-context - in-maint type: object properties: zone-id: type: string description: Code assigned by AIC to the zone zone-name: type: string description: English name associated with the zone design-type: type: string description: Design of zone [Medium/Large…] zone-context: type: string description: Context of zone [production/test] status: type: string description: Status of a zone. resource-version: type: string description: Concurrency value in-maint: type: boolean description: Used to indicate whether or not zone object is in maintenance mode. relationship-list: type: array items: $ref: '#/components/schemas/relationship1' description: '' description: >- A zone is a grouping of assets in a location homing to the same connections into the CBB ###### Related Nodes - 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) zone2: title: zone2 required: - zone-id - zone-name - design-type - zone-context type: object properties: zone-id: type: string description: Code assigned by AIC to the zone zone-name: type: string description: English name associated with the zone design-type: type: string description: Design of zone [Medium/Large…] zone-context: type: string description: Context of zone [production/test] status: type: string description: Status of a zone. description: >- A zone is a grouping of assets in a location homing to the same connections into the CBB ###### Related Nodes - 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) zones1: title: zones1 type: object properties: zone: type: array items: $ref: '#/components/schemas/zone1' description: '' description: Collection of zones tags: - name: CloudInfrastructure description: '' - name: ExternalSystem description: '' - name: Business description: '' - name: ServiceDesignAndCreation description: '' - name: Network description: '' - name: Common description: ''